Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bjbford committed Jul 27, 2018
1 parent 43454ff commit 76cf580
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
## Getting Started:
- Create a fork of the tutorials_devel repository
- `git clone` the forked repository
- Install markdown first: `pip install markdown`
- Install the required tools using `pip install -r requirements.txt`

## Information:
Expand Down Expand Up @@ -32,4 +33,4 @@ Note: Please do not push a build directory to GitHub.
- **ReadtheDocs**: an open-source software documentation hosting platform.
- **Sphinx**: documentation generator that can output formats such as: HTML, LaTeX, ePub's, etc.
- **reStructuredText**: easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and parser system. It is useful for in-line program documentation (such as Python docstrings), for quickly creating simple web pages, and for standalone documents. reStructuredText is designed for extensibility for specific application domains.
- **Markdown**: a lightweight markup language with plain text formatting syntax. It is designecd so that it can be converted to HTML and many other formats.
- **Markdown**: a lightweight markup language with plain text formatting syntax. It is designecd so that it can be converted to HTML and many other formats.

0 comments on commit 76cf580

Please sign in to comment.