Merge pull request #283 from sachaw/master

Update readme and fix CI formatting

.github/workflows/android.yml

@@ -8,12 +8,11 @@ on:
 jobs:
   test:
     name: Test
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
         with:
-          submodules: 'recursive'
+          submodules: true
-          
       - name: Loading secrets
         env:
           gservices: ${{ secrets.gservices }}
@@ -30,14 +29,14 @@ jobs:
 
           mkdir -p ~/.gradle
           echo "MAPBOX_DOWNLOADS_TOKEN=$mapboxtoken" >>~/.gradle/gradle.properties
-
       - name: Mock curfirmware version for CI
         run: |
           rm ./app/src/main/res/values/curfirmwareversion.xml
           cp ./app/special/curfirmwareversion.xml ./app/src/main/res/values/
-    - name: set up JDK 1.8
+      - name: set up Java
-      uses: actions/setup-java@master
+        uses: actions/setup-java@v2
         with:
-        java-version: 1.8
+          distribution: "adopt"
+          java-version: 16
       - name: Unit tests
         run: bash ./gradlew test --stacktrace

README.md

@@ -1,6 +1,6 @@
 # Meshtastic-Android
 
-![Android CI](https://github.com/meshtastic/Meshtastic-Android/workflows/Android%20CI/badge.svg?branch=master)
+[![Open in Visual Studio Code](https://open.vscode.dev/badges/open-in-vscode.svg)](https://open.vscode.dev/meshtastic/Meshtastic-Android)
 
 This is a tool for using Android with open-source mesh radios. For more information see our webpage: [meshtastic.org](https://www.meshtastic.org). If you are looking for the the device side code, see [here](https://github.com/meshtastic/Meshtastic-esp32).
 
@@ -33,43 +33,45 @@ the 'appeal' process, but for now you'll need to get the app from other places.
 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.
 
-* 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:
 
-```
+```bash
-        rm ./app/google-services.json
+rm ./app/google-services.json
-        cp ./app/google-services-example.json ./app/google-services.json
+cp ./app/google-services-example.json ./app/google-services.json
-        rm ./app/src/main/res/values/mapbox-token.xml
+rm ./app/src/main/res/values/mapbox-token.xml
-        cp ./app/special/mapbox-token.xml ./app/src/main/res/values/
+cp ./app/special/mapbox-token.xml ./app/src/main/res/values/
-        rm ./app/src/main/res/values/curfirmwareversion.xml
+rm ./app/src/main/res/values/curfirmwareversion.xml
-        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
+```bash
+cat ~/.gradle/gradle.properties
 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 phone
-or the emulator.  Note: The emulators don't support bluetooth, so some features can not be used in
+  or the emulator. Note: The emulators don't support bluetooth, so some features can not be used in
-that environment.
+  that environment.
 
 ## 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
+```bash
 adb shell setprop debug.firebase.analytics.app com.geeksville.mesh
 adb shell setprop log.tag.FirebaseCrashlytics DEBUG
 ```
 
 for verbose logging:
-```shell
+
+```bash
 adb shell setprop log.tag.FA VERBOSE
 ```
 
@@ -81,19 +83,17 @@ adb shell setprop log.tag.FA VERBOSE
 
 This project is the work of volunteers:
 
-* @artemisoftnian: Contributed Spanish translations.
+- @artemisoftnian: Contributed Spanish translations.
-* @CycloMies: Contributed Swedish, Finnish and German translations.
+- @CycloMies: Contributed Swedish, Finnish and German translations.
-* @eriktheV-king: Contributed Dutch and French translations.
+- @eriktheV-king: Contributed Dutch and French translations.
-* @Lgoix: Contributed tooltip for radio mode
+- @Lgoix: Contributed tooltip for radio mode
-* @Eugene: Contributed Russian translation.
+- @Eugene: Contributed Russian translation.
-* @Jinx17: Contributed Slovenian translation.
+- @Jinx17: Contributed Slovenian translation.
-* @Konradrundfunk: Contributed German fixes.
+- @Konradrundfunk: Contributed German fixes.
-* @Mango-sauce: Contributed Chinese translation.
+- @Mango-sauce: Contributed Chinese translation.
-* @NEKLAN: Contributed Japanese translation.
+- @NEKLAN: Contributed Japanese translation.
-* @Ohcdh: Contributed Irish and Italian translations.
+- @Ohcdh: Contributed Irish and Italian translations.
-* @Slavino: Contributed Slovak translation.
+- @Slavino: Contributed Slovak translation.
-* @Zone: Contributed Turkish translation.
+- @Zone: Contributed Turkish translation.
 
 Copyright 2019, Geeksville Industries, LLC. GPL V3 license
-
-