whits
/
docs
forked from tilde.black/docs
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

updated readme

This commit is contained in:
James Tomasino 2019-07-30 23:22:39 +00:00
parent f45c866477
commit 8d9cffc7af
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -6,16 +6,20 @@ This repository holds the outward facing guides built by users of https://tilde.
### Running the docs
1. Install `mkdocs` according to your platform requirements. Many package managers have it included, and there is also a pip version available.
1. You should have python3 pip3 and virtualenv installed on your system.
2. Fork this repository & clone it to your system.
3. Change to your repository directory and run:
3. Change to the repository directory and run `source ./activate` to install all the dependencies and activate your virtual environment for python.
4. Finally, run:
$ mkdocs serve
This will launch a local running version of the documentation on https://localhost:8000. As you make changes to the documentation your changes will appear in your local server.
To quit your virtual environment just run the command "deactivate" in your shell.
### Submitting changes
If you would like to contribute to these guides you do not need an account on tilde.black, but you may benefit from discussion in the private forums on that platform. To contribute, clone this repository, make any desired changes, and submit a pull-request.