From c54f5c7d76c0d45472bf0b2d3b4d9686b337d2b3 Mon Sep 17 00:00:00 2001 From: clara bayley Date: Tue, 27 Feb 2024 15:57:41 +0100 Subject: [PATCH] delete dollar symbols on consol commands --- README.md | 8 ++++---- docs/source/usage/getstart.rst | 4 ++-- docs/source/usage/ourdocs.rst | 6 +++--- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 711a3ea..7b078b6 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ George Datseris. ## Install To (locally) reproduce this project simply clone the repository. ``` -$ git clone https://github.com/yoctoyotta1024/GoodSciProjTemplate.git +git clone https://github.com/yoctoyotta1024/GoodSciProjTemplate.git ``` You will need to run ``pre-commit install`` but other than that all the necessary packages for you to run & have fun with everything should work out of the box... If not, please raise an issue on the @@ -24,9 +24,9 @@ files using Doxygen followed by .html files using Sphinx, then view the .html in browser. E.g. ``` -$ cd ./docs && mkdir build && mkdir build/doxygen -$ doxygen doxygen/doxygen.dox && make html -$ open build/html/index.html +cd ./docs && mkdir build && mkdir build/doxygen +doxygen doxygen/doxygen.dox && make html +open build/html/index.html ``` Thank you and good luck! diff --git a/docs/source/usage/getstart.rst b/docs/source/usage/getstart.rst index 56d8fe8..2434460 100644 --- a/docs/source/usage/getstart.rst +++ b/docs/source/usage/getstart.rst @@ -7,12 +7,12 @@ Clone GoodSciProjTemplate's GitHub repository: .. code-block:: console - $ git clone https://github.com/yoctoyotta1024/GoodSciProjTemplate.git + git clone https://github.com/yoctoyotta1024/GoodSciProjTemplate.git and install the pre-commit hooks: .. code-block:: console - $ pre-commit install + pre-commit install That's it, you're done! But maybe now you want to customise the project and push it to your own GitHub repo... diff --git a/docs/source/usage/ourdocs.rst b/docs/source/usage/ourdocs.rst index ec5ab28..bc4a527 100644 --- a/docs/source/usage/ourdocs.rst +++ b/docs/source/usage/ourdocs.rst @@ -9,14 +9,14 @@ followed by the Sphinx .html files, e.g. .. code-block:: console - $ cd ./docs && mkdir build && mkdir build/doxygen - $ doxygen doxygen/doxygen.dox && make html + cd ./docs && mkdir build && mkdir build/doxygen + doxygen doxygen/doxygen.dox && make html which you can then view in your preferred browser e.g. .. code-block:: console - $ open build/html/index.htm + open build/html/index.htm Sphinx ######