Skip to content

Commit 238a8f6

Browse files
Merge pull request #85 from pyscript/getting-started-contribution
Improved the contribution "getting started"
2 parents fcf09e7 + 6a49538 commit 238a8f6

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

Diff for: .gitignore

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
_env
22
site
3-
.DS_Store
3+
.DS_Store
4+
bin
5+
lib
6+
lib64
7+
pyvenv.cfg

Diff for: README.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,16 @@ To setup the documentation development environment simply create a new
2222
virtual environment, then `pip install -r requirements.txt` (from in the root
2323
of this repository).
2424

25+
```sh
26+
# example of a simple virtual environment
27+
# creation from the root of this project
28+
python -m venv .
29+
./bin/pip install -r requirements.txt
30+
```
31+
2532
## Build
2633

27-
Simply run `mkdocs serve`
34+
Simply run `mkdocs serve` or `./bin/mkdocs serve`.
2835

2936
## Cross-referencing
3037

0 commit comments

Comments
 (0)