Skip to content

Commit

Permalink
delete dollar symbols on consol commands
Browse files Browse the repository at this point in the history
  • Loading branch information
yoctoyotta1024 committed Feb 27, 2024
1 parent b96a45a commit c54f5c7
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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!
Expand Down
4 changes: 2 additions & 2 deletions docs/source/usage/getstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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...
Expand Down
6 changes: 3 additions & 3 deletions docs/source/usage/ourdocs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
######
Expand Down

0 comments on commit c54f5c7

Please sign in to comment.