Brewery/gravitymon
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updates to docs

Browse Source
This commit is contained in:
Magnus Persson
2022-01-09 09:23:40 +01:00
parent 2662f38bf7
commit e234d6f908
9 changed files with 179 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
src_docs/source/compiling.rst
View File

@ -1,5 +1,7 @@
.. _compiling-the-software:
Compiling the software
-----------------------
######################
Tools
=====
@ -14,7 +16,7 @@ Code Formatting
===============
I use pre-commit and their cpp style checks to validate the code. Plugin defintions are found in **.pre-commit-config.yaml**
https://www.pre-commit.com
`Pre-Commit <https://www.pre-commit.com>`_
.. note::
@ -23,12 +25,19 @@ https://www.pre-commit.com
Targets
=======
In the repository there are 3 targets defined
In the platformio config there are 3 targets defined
* gravity-debug; Maximum logging for trouble shooting, deep sleep is disabled.
* gravity-release; Standard release
* gravity-perf; Standard release but contains code for measuring performance
.. warning::
The debug target can be unsable and crash the device under certain circumstanses.
Excessive logging to the serial port can cause corruption and crashes. I'm still
trying to figure out what causes these issues in the debug target. Other targets are
stable and works fine.
Source structure
================
.. list-table:: Directory structure