Skip to content

Improved the contribution "getting started" #85

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 22, 2024
Merged

Improved the contribution "getting started" #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
_env
site
.DS_Store
.DS_Store
bin
lib
lib64
pyvenv.cfg
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,16 @@ To setup the documentation development environment simply create a new
virtual environment, then `pip install -r requirements.txt` (from in the root
of this repository).

```sh
# example of a simple virtual environment
# creation from the root of this project
python -m venv .
./bin/pip install -r requirements.txt
```

## Build

Simply run `mkdocs serve`
Simply run `mkdocs serve` or `./bin/mkdocs serve`.

## Cross-referencing

Expand Down