readme with build instructions.

This commit is contained in:
Paul Irish 2013-06-24 19:22:57 -07:00
Родитель 5186253c57
Коммит ff75d12509
1 изменённых файлов: 17 добавлений и 0 удалений

17
readme.md Normal file
Просмотреть файл

@ -0,0 +1,17 @@
# How to run the site
1. In the root of the project, start a [server] (https://github.com/paulirish/dotfiles/blob/3fa2e7dc1f1ea5eaf7f6a2531b937ff8bd8833f9/.functions#L25-L32).
* it's easier if your server can also do a directory listing.
1. open [http://localhost:8000/docs/_preview.html](http://localhost:8000/docs/_preview.html)
1. you'll see the boilerplate along with a directory listing
![image](https://f.cloud.github.com/assets/39191/700223/d42cb838-dd3d-11e2-8bf3-af57e883cd80.png)
1. Click one of them.
1. It should bring you to a url like [http://localhost:8000/docs/_preview.html?settings.html](http://localhost:8000/docs/_preview.html?settings.html)
* you can navigate to this directly if you like
* it looks like this ![image](https://f.cloud.github.com/assets/39191/700211/6b936d08-dd3d-11e2-8d4b-19db48d65c56.png)
* Things mostly work.
## Known issues
* no markdown support yet.