Add gitpod as a compiling option (#1392)
Some checks are pending
CI / quality (push) Waiting to run
CI / build (push) Waiting to run

* Add gitpod as a compiling option

Gitpod is a clean way to compile the firmware for casuals like me, without installing anything locally.

* Apply suggestions from code review

Co-authored-by: rcarteraz <robert.l.carter2@gmail.com>

* Update now that .gitpod.yaml is merged

P.io is installed at the opening of a new workspace, so I've removed step 2.

Ready to go!

---------

Co-authored-by: rcarteraz <robert.l.carter2@gmail.com>
This commit is contained in:
Nestpebble 2024-08-24 04:30:12 +01:00 committed by GitHub
parent 9391a5397a
commit c6e4307caa
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -67,3 +67,15 @@ The build system is modular. Adding a new board variant for an already supported
5. Add your board identifier to `architecture.h` on the firmware repo in the folder of the platform you are using, and send in that Pull Request too.
6. Wait for the Pulls to be merged back into Master.
7. Profit :-)
## Alternative route: Gitpod
Gitpod offers an alternative method for compiling the firmware without installing Visual Studio Code. It is a web browser-based online IDE that can be used with a GitHub account. Gitpod provides a free tier suitable for light use, such as compiling custom firmware.
1. Go to (https://gitpod.io#https://github.com/meshtastic/firmware)[https://gitpod.io#https://github.com/meshtastic/firmware].
2. Make the desired changes to the chosen variant.
3. Build the firmware by running: `pio run -e <variant_name>`
4. Once complete, download `<variant_name>.bin` or `<variant_name>.uf2` from `/workspace/firmware/.pio/build/<variant_name>.`
5. As flashing directly to the device isn't possible using Gitpod, upload using either:
- [Drag & Drop](/docs/getting-started/flashing-firmware/nrf52/#drag--drop) for NRF52/RP2040 devices.
- [Web flasher](https://flasher.meshtastic.org/) for ESP32 devices.