Updated docs
This commit is contained in:
parent
390c0882d1
commit
fca7294b61
@ -5,7 +5,18 @@ Anyone is welcome to contribute to this project or create their own variant of i
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
.. 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
|
||||
------------
|
||||
|
@ -7,7 +7,7 @@ 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.9 <https://mp-se.github.io/gravitymon/v0.9/index.html>`_
|
||||
|
Loading…
Reference in New Issue
Block a user