From fca7294b6198c2ba4f655eb43dd411f45ffa48d3 Mon Sep 17 00:00:00 2001 From: Magnus Persson Date: Sun, 8 May 2022 09:58:26 +0200 Subject: [PATCH] Updated docs --- src_docs/source/contributing.rst | 13 ++++++++++++- src_docs/source/index.rst | 2 +- 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/src_docs/source/contributing.rst b/src_docs/source/contributing.rst index 16b8a46..47ba0d3 100644 --- a/src_docs/source/contributing.rst +++ b/src_docs/source/contributing.rst @@ -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 `_ 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 ------------ diff --git a/src_docs/source/index.rst b/src_docs/source/index.rst index 8e4c78b..a3d1273 100644 --- a/src_docs/source/index.rst +++ b/src_docs/source/index.rst @@ -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 `_ * Docs for: `v0.9 `_