Merge branch 'master' into master

.github/workflows/doxygen.yml

@@ -0,0 +1,45 @@
+name: DoxyGen build
+
+on:
+  pull_request:
+    branches:
+      - master
+  push:
+    branches:
+      - master
+  release:
+    branches:
+      - master
+    types:
+      - published
+      - edited
+
+jobs:
+  build-doxygen:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: get latest release version number
+      id: latest_ver
+      uses: pozetroninc/github-action-get-latest-release@master
+      with:
+        repository: nRF24/RF24Mesh
+    - name: checkout
+      uses: actions/checkout@v2
+    - name: overwrite doxygen tags
+      run: |
+        mkdir docs
+        touch doxygenAction
+        echo "PROJECT_NUMBER = ${{ steps.latest_ver.outputs.release }}" >> doxygenAction
+        echo "@INCLUDE = doxygenAction" >> Doxyfile
+    - name: build doxygen
+      uses: mattnotmitt/doxygen-action@v1
+      with:
+          working-directory: '.'
+          doxyfile-path: './Doxyfile'
+    - name: upload to github pages
+      if: ${{ github.event_name == 'release'}}
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./docs/html

.gitignore

@@ -0,0 +1,9 @@
+# Executables from examples
+*/bin/*
+
+# Generated library files
+*.so
+*.so.1
+
+# ignore docs folder
+docs/

CONTRIBUTING.md

@@ -0,0 +1,9 @@
+These are the current requirements for getting your code included in RF24Mesh:
+
+* Try your best to follow the rest of the code, if you're unsure then the NASA C style can help as it's closest to the current style: https://ntrs.nasa.gov/archive/nasa/casi.ntrs.nasa.gov/19950022400.pdf
+
+* Definetly follow PEP-8 if it's Python code.
+
+* Follow the Arduino IDE formatting style for Arduino examples
+
+* Add doxygen-compatible documentation to any new functions you add, or update existing documentation if you change behaviour