From eda4862f0d8421e8489bfbda2f5f982a29494038 Mon Sep 17 00:00:00 2001 From: Dafeman <47490997+Dafeman@users.noreply.github.com> Date: Thu, 3 Sep 2020 08:34:52 +1200 Subject: [PATCH] Update build-instructions.md --- docs/software/build-instructions.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/docs/software/build-instructions.md b/docs/software/build-instructions.md index b6bbfb60..7434b3a5 100644 --- a/docs/software/build-instructions.md +++ b/docs/software/build-instructions.md @@ -4,13 +4,19 @@ This project uses the simple PlatformIO build system. PlatformIO is an extension ## GUI 1. Purchase a suitable [radio](https://github.com/meshtastic/Meshtastic-device/wiki/Hardware-Information). -2. Install [PlatformIO](https://platformio.org/platformio-ide). -3. Click the PlatformIO icon on the side bar. ![platformio icon](https://user-images.githubusercontent.com/47490997/89482668-77c7ea00-d7ee-11ea-8785-5faf8ff99800.png) -4. Under `Quick Access, Miscellaneous, Clone Git Project` enter the URL of the Meshtastic repo found [here](https://github.com/meshtastic/Meshtastic-device). ![image](https://user-images.githubusercontent.com/47490997/89483047-4c91ca80-d7ef-11ea-91f4-1d53d4e8acd9.png) -5. Select a file location to save the repo. -6. Once loaded, open the `platformio.ini` file. -7. At the line `default_envs` you can change it to the board type you are building for ie. `tlora-v2, tlora-v1, tlora-v2-1-1.6, tbeam, heltec, tbeam0.7` (boards are listed further down in the file). -8. Click the PlatformIO icon on the side bar. Under `Project Tasks` you can now build or upload. +2. Install [Python](https://www.python.org/downloads/). +3. Install [Git](https://git-scm.com/downloads). +4. Reboot your computer. +5. Install [PlatformIO](https://platformio.org/platformio-ide). +6. Click the PlatformIO icon on the side bar. ![platformio icon](https://user-images.githubusercontent.com/47490997/89482668-77c7ea00-d7ee-11ea-8785-5faf8ff99800.png) +7. Under `Quick Access, Miscellaneous, Clone Git Project` enter the URL of the Meshtastic repo found [here](https://github.com/meshtastic/Meshtastic-device). ![image](https://user-images.githubusercontent.com/47490997/89483047-4c91ca80-d7ef-11ea-91f4-1d53d4e8acd9.png) +8. Select a file location to save the repo. +9. Once loaded, open the `platformio.ini` file. +10. At the line `default_envs` you can change it to the board type you are building for ie. `tlora-v2, tlora-v1, tlora-v2-1-1.6, tbeam, heltec, tbeam0.7` (boards are listed further down in the file). +11. The hardware can be configured for different countries by adding a definition to the `configuration.h` file. `#define HW_VERSION_US` or `HW_VERSION_EU433, HW_VERSION_EU865, HW_VERSION_CN, HW_VERSION_JP`. Other country settings can be found in `MeshRadio.h`. The default is `HW_VERSION_US`. +12. Click the PlatformIO icon on the side bar. Under `Project Tasks` you can now build or upload. + +Note - To get a clean build you may have to delete the auto-generated file `./.vscode/c_cpp_properties.json`, close and re-open Visual Studio and WAIT until the file is auto-generated before compiling again. ## Command Line 1. Purchase a suitable [radio](https://github.com/meshtastic/Meshtastic-device/wiki/Hardware-Information).