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

added Readme

This commit is contained in:
James Tomasino 2019-04-24 21:01:19 -04:00
parent e459989228
commit 85942eb623
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md Normal file
View File

@ -0,0 +1,23 @@
# Tilde Black Documentation
This repository holds the outward facing guides built by users of https://tilde.black.
## Local Development
### 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.
2. Fork this repository & clone it to your system.
3. Change to your repository directory and 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.
### 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.