Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mhilbrunner committed May 22, 2018
1 parent a5ef076 commit 47758cd
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,18 @@
# docs
# aiPhilos docs

This repository contains the source for the [aiPhilos](https://aiphilos.com) docs and tutorials located under [docs.aiphilos.com](https://docs.aiphilos.com), kindly hosted by [ReadTheDocs](https://readthedocs.io). Pull requests welcome!

## Setup

1. Install [Python](https://www.python.org/downloads/)
1. Add Python to path
1. Update pip: `python -m pip install --upgrade pip`
1. Install dependencies: `pip install sphinx sphinx-autobuild recommonmark`
1. Clone repository: `git clone https://github.com/aiphilos/docs.git`
1. Make your changes
1. Build: `make html` in the root folder
1. Updated website HTML is now in `_build/`

## Contact

Feel free to [contact us](https://www.aiphilos.com/kontakt)!

0 comments on commit 47758cd

Please sign in to comment.