Skip to content

Commit bd3c4d3

Browse files
committed
Update readme.md
1 parent ea7510c commit bd3c4d3

File tree

2 files changed

+15
-9
lines changed

2 files changed

+15
-9
lines changed

README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,48 @@
11
# Virtual Anatomy Documentation
2-
Documentation created using MkDocs.
3-
4-
[Link](https://jrcz-data-science-lab.github.io/VirtualAnatomy-Documentation/)
2+
Documentation for the [Virtual Anatomy project](https://github.com/jrcz-data-science-lab/Virtual-Anatomy-UE) created on MkDocs.
53

64
## Branches
75
- **`main`**: Contains the main content of the documentation.
86
- **`gh-pages`**: Auto-generated by a bot, contains the published documentation.
97

108
## Installation
119

12-
Ensure that you have `pip` and `python` installed.
10+
First of all, ensure that you have `pip` and `python` packages installed.
1311

1412
Then, run the following command to install MkDocs:
1513

1614
```bash
1715
pip install mkdocs
1816
```
1917

20-
We use material theme and so should you ;), install it using following.
18+
The material theme is used within this documentation. For the best UI experience install it using the following command:
2119

2220
```bash
2321
pip install mkdocs-material
2422
```
2523

26-
Afterward, serve the documentation locally by running:
24+
Afterward, you can serve the documentation locally by running:
2725

2826
```bash
2927
mkdocs serve
3028
```
3129

32-
Make sure to execute this command in the root of the repository.
30+
**Make sure to execute this command in the root of the repository.**
3331

3432
## Adding Pages
3533

3634
You should **always** add new `.md` files to the `docs` folder. You can create new folders and sub folders if necessary.
3735

38-
If your file is located inside the `docs` folder it will get automatically interpreted by the mk-docs framework
36+
If your file is located inside the `docs` folder it will get automatically interpreted by the mk-docs framework.
3937

4038
## Updating the deployed website
4139

42-
Once you're done, `add` your changes, `commit`, and `push`. The GitHub action will trigger, and the `gh-pages` branch will be updated with your changes (bot will deploy it as static website and push to the `gh-page` branch).
40+
Once you are done with (part of) your documentation, `add` your changes, `commit`, and `push` them to `main` branch. The GitHub action will trigger, and the `gh-pages` branch will be updated with your changes (bot will deploy it as static website and push to the `gh-page` branch).
41+
42+
## Authors/Contributors
43+
44+
[Simon Potocnak](https://github.com/wpsimon09),
45+
[Daniel Bartha](https://github.com/DanielBartha),
46+
[Kristers Gruzins](https://github.com/animepuika),
47+
[Bartosz Adamczyk](https://github.com/Bartan02),
48+
[Mārtiņš Greizis](https://github.com/MGreizis)
File renamed without changes.

0 commit comments

Comments
 (0)