Skip to content

Commit 989f3c0

Browse files
authored
Merge pull request #2 from kklamberty/update-notes-about-how-to-contribute
Update documentation about how to contribute
2 parents fd66c4e + 84a1060 commit 989f3c0

1 file changed

Lines changed: 7 additions & 4 deletions

File tree

README.rst

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,13 @@ You can see and read this book online at `runestone.academy <http://runestone.ac
3030
Building with PreTeXt
3131
---------------------
3232

33-
1. Create a virtual environment
34-
2. pip install pretextbook
35-
3. To build run: pretext build web
36-
4. pretext view web
33+
1. Create and activate a virtual environment (for more about Python virtual environments, `view the documentation <https://docs.python.org/3/library/venv.html#creating-virtual-environments>`_)
34+
2. Move into the directory that is the virtual environment
35+
3. Clone this repo (or a fork of this repo)
36+
4. Move into the top-level directory of the cloned repo
37+
5. Run ``pip install pretext`` (for more about PreTeXt, visit `the PreTeXt Guide <https://pretextbook.org/doc/guide/html/processing-CLI.html>`_)
38+
6. To build run: ``pretext build web``
39+
7. To view the resulting textbook run: ``pretext view web``
3740

3841
Note: The pretext sources are in the pretext folder, we will keep the _sources folder until we are 100% sure that the book has been converted correctly and as thoroughly as possible.
3942

0 commit comments

Comments
 (0)