Update documentation

This commit is contained in:
GitHub Action 2022-05-08 08:07:15 +00:00
parent aa5e2b738c
commit 030c0d8ad6
5 changed files with 83 additions and 11 deletions

View File

@ -1,5 +1,33 @@
Contributing
############
Anyone is welcome to contribute to this project or create their own variant of it. I would appreciate a PR if your feature would be of benefit other users.
In order to keep the source code in good condition I use `pre-commit <https://pre-commit.com/>`_ to validate and format the code using their standards for C++/C.
.. note::
If you are using Windows as a base platform I would suggest that you install pre-commit under wsl (Windows Subssytem for Windows) and run it from there, I have found
that this approach works fine.
The following command will run pre-commit on all the source files. Assuming you are inte project directory.
.. code-block::
pre-commit run --files src/*
Design goals
------------
This section is under construction.
My goals with this software has been the following:
* Create an open software for the excellent iSpindle hardware platform that is open and available for anyone.
* Add user requested features that have not made it into the iSpindle project.
* Focus on long battery life and stability.
* Explore new technologies and create the next generation gravity monitoring for home brewers.
I will do my best to assist users and respond to new features, pr and suggestions. But keep in mind I'm doing this on my spare time.
Regards, Magnus

View File

@ -7,9 +7,9 @@ Welcome to GravityMon's documentation!
######################################
.. note::
This documentation reflects **v1.0**. Last updated 2022-05-06
This documentation reflects **v1.0**. Last updated 2022-05-08
* Docs for: `v0.8 <https://mp-se.github.io/gravitymon/v0.8index.html>`_
* Docs for: `v0.8 <https://mp-se.github.io/gravitymon/v0.8/index.html>`_
* Docs for: `v0.9 <https://mp-se.github.io/gravitymon/v0.9/index.html>`_
.. image:: images/gravitymon.gif

View File

@ -133,7 +133,7 @@
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
<label class="toc-overlay-icon toc-header-icon" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
@ -197,7 +197,7 @@
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
<label class="toc-overlay-icon toc-content-icon" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
@ -205,7 +205,29 @@
<article role="main">
<div class="section" id="contributing">
<h1>Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline">#</a></h1>
<p>This section is under construction.</p>
<p>Anyone is welcome to contribute to this project or create their own variant of it. I would appreciate a PR if your feature would be of benefit other users.</p>
<p>In order to keep the source code in good condition I use <a class="reference external" href="https://pre-commit.com/">pre-commit</a> to validate and format the code using their standards for C++/C.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>If you are using Windows as a base platform I would suggest that you install pre-commit under wsl (Windows Subssytem for Windows) and run it from there, I have found
that this approach works fine.</p>
</div>
<p>The following command will run pre-commit on all the source files. Assuming you are inte project directory.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pre</span><span class="o">-</span><span class="n">commit</span> <span class="n">run</span> <span class="o">--</span><span class="n">files</span> <span class="n">src</span><span class="o">/*</span>
</pre></div>
</div>
<div class="section" id="design-goals">
<h2>Design goals<a class="headerlink" href="#design-goals" title="Permalink to this headline">#</a></h2>
<p>My goals with this software has been the following:</p>
<ul class="simple">
<li><p>Create an open software for the excellent iSpindle hardware platform that is open and available for anyone.</p></li>
<li><p>Add user requested features that have not made it into the iSpindle project.</p></li>
<li><p>Focus on long battery life and stability.</p></li>
<li><p>Explore new technologies and create the next generation gravity monitoring for home brewers.</p></li>
</ul>
<p>I will do my best to assist users and respond to new features, pr and suggestions. But keep in mind Im doing this on my spare time.</p>
<p>Regards, Magnus</p>
</div>
</div>
</article>
@ -253,9 +275,28 @@
</footer>
</div>
<aside class="toc-drawer no-toc">
<aside class="toc-drawer">
<div class="toc-sticky toc-scroll">
<div class="toc-title-container">
<span class="toc-title">
Contents
</span>
</div>
<div class="toc-tree-container">
<div class="toc-tree">
<ul>
<li><a class="reference internal" href="#">Contributing</a><ul>
<li><a class="reference internal" href="#design-goals">Design goals</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</aside>
</div>

View File

@ -207,10 +207,10 @@
<h1>Welcome to GravityMons documentation!<a class="headerlink" href="#welcome-to-gravitymon-s-documentation" title="Permalink to this headline">#</a></h1>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This documentation reflects <strong>v1.0</strong>. Last updated 2022-05-06</p>
<p>This documentation reflects <strong>v1.0</strong>. Last updated 2022-05-08</p>
</div>
<ul class="simple">
<li><p>Docs for: <a class="reference external" href="https://mp-se.github.io/gravitymon/v0.8index.html">v0.8</a></p></li>
<li><p>Docs for: <a class="reference external" href="https://mp-se.github.io/gravitymon/v0.8/index.html">v0.8</a></p></li>
<li><p>Docs for: <a class="reference external" href="https://mp-se.github.io/gravitymon/v0.9/index.html">v0.9</a></p></li>
</ul>
<a class="reference internal image-reference" href="_images/gravitymon.gif"><img alt="User Inteface Walkthrough" src="_images/gravitymon.gif" style="width: 800px;"/></a>
@ -415,7 +415,10 @@ the following libraries and without these this would have been much more difficu
<li class="toctree-l2"><a class="reference internal" href="compiling.html#options">Options</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="contributing.html#design-goals">Design goals</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="hardware.html">Hardware</a><ul>
<li class="toctree-l2"><a class="reference internal" href="hardware.html#schema-for-esp8266-build">Schema for esp8266 build</a></li>
<li class="toctree-l2"><a class="reference internal" href="hardware.html#schema-for-esp32-build">Schema for esp32 build</a></li>

File diff suppressed because one or more lines are too long