Skip to content

Commit

Permalink
Building from browser guide
Browse files Browse the repository at this point in the history
  • Loading branch information
reppad committed Nov 16, 2023
1 parent 85d102d commit bfc2944
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
// "forwardPorts": [],

// Use 'postCreateCommand' to run commands after the container is created.
"postCreateCommand": "sudo apt update && sudo apt install -y build-essential gcc-arm-none-eabi=15:10.3-2021.07-4 && pip install crcmod && git submodule update --init --recursive --depth=1"
"postCreateCommand": "sudo apt update && sudo apt install -y build-essential gcc-arm-none-eabi=15:10.3-2021.07-4 && git submodule update --init --recursive --depth=1"

// Configure tool-specific properties.
// "customizations": {},
Expand Down
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,27 @@ See __Compiler__, __Building__ and __Flashing__ sections below.
## Pre-built firmware
You can find pre-built firmwares in the [Actions](https://github.com/OEFW-community/RT-890-custom-firmware/actions)

## Building from browser

To build the firmware without installing any software you can run a full featured IDE and compiler in your browser using GitHub Codespace.
The preconfigured environment runs Linux Ubuntu 22.04 with gcc-arm-none-eabi 15:10.3-2021.07-4.

### Starting a new Codespace

You just need to clic on the green button `<> Code` -> `Codespace` -> `Create Codespace on ...`
After the Codespace is initialized, you can open and edit any file, for example, modify the options in the makefile and build the firmware typing `make` in the terminal panel.

### Starting an existing Codespace

If you started a Codespace less than 7 days ago and have not manually deleted it, then you will be offered to restart it instead of creating a new one.
The start-up will be much faster but you will need to update the code before compiling as it will contain the version of the code from the time of its creation.
To do this, simply type the following commands in the console: `make clean`, then `git pull`, and finally `make`.

### A word about the free offer
The most observant users will have noticed this message: `Codespace usage for this repository is paid for by...`
Github will never charge you without consent. If you reach the limit of the free offer, which is very unlikely, you will not be able to start your codespaces until the monthly limits reset, that's all.
[More informations](https://docs.github.com/en/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces)

## Telegram group
If you want to discuss this project, you can join the [Telegram group](https://t.me/RT890_OEFW).

Expand Down

0 comments on commit bfc2944

Please sign in to comment.