mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-12-26 22:19:46 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Small fixees

Browse source
This commit is contained in:
apt105 2021-05-26 23:17:36 +01:00
parent 4b100951c2
commit 445d4536ae
3 changed files with 17 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
website/docs/developers/android/build.md
View file

@ -4,16 +4,13 @@ title: Creating a build/development environment for the Android App
sidebar_label: Building Android App sidebar_label: Building Android App
--- ---
## Build instructions ## Build instructions
If you would like to develop this application we'd love your help! These build instructions are brief If you would like to develop this application we'd love your help! These build instructions are brief and should be improved, please send a PR if you can.
and should be improved, please send a PR if you can.
* Use Android Studio 4.1.2 to build/debug (other versions might work but no promises) * Use Android Studio 4.1.2 to build/debug (other versions might work but no promises)
* Use "git submodule update --init --recursive" to pull in the various submodules we depend on * Use "git submodule update --init --recursive" to pull in the various submodules we depend on
* There are a few config files which you'll need to copy from templates included in the project. * There are a few config files which you'll need to copy from templates included in the project. Run the following commands to do so:
Run the following commands to do so:
``` ```
rm ./app/google-services.json rm ./app/google-services.json
@ -24,21 +21,22 @@ Run the following commands to do so:
cp ./app/special/curfirmwareversion.xml ./app/src/main/res/values/ cp ./app/special/curfirmwareversion.xml ./app/src/main/res/values/
``` ```
* (unfortunately) you need to get a (free) mapbox developer token [here](https://docs.mapbox.com/android/maps/guides/install/) and put that token in your user gradle.properties. * (Unfortunately) you need to get a (free) mapbox developer token [here](https://docs.mapbox.com/android/maps/guides/install/) and put that token in your user gradle.properties.
``` ```
~/development/meshtastic/MeshUtil$ cat ~/.gradle/gradle.properties ~/development/meshtastic/MeshUtil$ cat ~/.gradle/gradle.properties
MAPBOX_DOWNLOADS_TOKEN=sk.yourtokenherexxx MAPBOX_DOWNLOADS_TOKEN=sk.yourtokenherexxx
``` ```
* Now you should be able to select "Run / Run" in the IDE and it will happily start running on your phone * Now you should be able to select "Run / Run" in the IDE and it will happily start running on your phoneor the emulator.
or the emulator. Note: The emulators don't support bluetooth, so some features can not be used in
that environment. :::note
The emulators don't support bluetooth, so some features can not be used in that environment.
:::
## Analytics setup ## Analytics setup
* analytics are included but can be disabled by the user on the settings screen * Analytics are included but can be disabled by the user on the settings screen
* On dev devices
* on dev devices
```shell ```shell
adb shell setprop debug.firebase.analytics.app com.geeksville.mesh adb shell setprop debug.firebase.analytics.app com.geeksville.mesh
@ -52,4 +50,4 @@ adb shell setprop log.tag.FA VERBOSE
## Publishing to google play ## Publishing to google play
(Only supported if you are a core developer that needs to do releases) * Only supported if you are a core developer that needs to do releases

4
website/docs/developers/build.md
View file

@ -22,4 +22,6 @@ This project uses the simple PlatformIO build system. PlatformIO is an extension
10. 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`. 10. 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`.
11. Click the PlatformIO icon on the side bar. Under `Project Tasks` you can now build or upload. 11. 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. :::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.
:::

6
website/docs/developers/codespaces.md
View file

@ -19,10 +19,10 @@ After that you will be added to the waiting list and will be contacted when you
![On the Codespaces waiting list](/img/codespaces/codespaces-waitinglist-sm.png) ![On the Codespaces waiting list](/img/codespaces/codespaces-waitinglist-sm.png)
Once you have been granted access, go to the project you wish to develop (for example the [Meshtastic device code](https://github.com/meshtastic/Meshtastic-device) or the [backend server code](https://github.com/meshtastic/meshtastic-backend)) and click the button in the upper right that says "Fork". It will ask you to confirm, then GitHub will generate your "fork" of the master code. Once you have been granted access, go to the project you wish to develop (for example the [Meshtastic device code](https://github.com/meshtastic/Meshtastic-device) or the [backend server code](https://github.com/meshtastic/meshtastic-backend)) and click the button in the upper right that says "Fork". It will ask you to confirm, then GitHub will generate your "fork" of the master code.
<!--add images for this section once I have access to Codespaces--> <!--add images for this section once I have access to Codespaces-->
Browse to your fork of the code and in the upper right of the window click on the "Code" dropdown button, then click "Open with Codespaces" Browse to your fork of the code and in the upper right of the window click on the "Code" dropdown button, then click "Open with Codespaces".
Github will then create a new virtual machine for you. This will take a few minutes the first time it is created as it installs Platformio and other dependancies. Github will then create a new virtual machine for you. This will take a few minutes the first time it is created as it installs Platformio and other dependancies.
You can now edit code and click to build and run just like you are on your own machine. You can now edit code and click to build and run just like you are on your own machine.
<!--add examples of usage--> <!--add examples of usage-->