cookiecutter/cookiecutter-django
1
1
Fork 0
mirror of https://github.com/cookiecutter/cookiecutter-django.git synced 2025-02-27 17:00:44 +03:00
Code Issues Packages Projects Releases Wiki Activity

added a pointer to app-specific documentation

Browse Source
This commit is contained in:
Lyla Fischer 2013-09-28 22:07:40 -04:00
parent 0b40e9bd3c
commit d0e27716c9
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.rst
View File

@ -83,8 +83,11 @@ Create a GitHub repo and push it there::
Now take a look at your repo. Awesome, right? Now take a look at your repo. Awesome, right?
It's time to write the code!!! If you check out your new application, you will see that you can find documentation in the "docs" directory that explains everything about your app as it exists in its initial cookiecutter state, including how to deploy it.
If you want to read the documentation from your browser instead of a text editing window, you'll have to compile it first. First, make sure that you have all of the local packages that you need (including the ones you need to generate this documentation) by running "pip install -r requirements/local.txt". Go into the docs directory and run "make html". That will generate html from the .rst files. If you point your browser to your local variant of "/path/to/my_cookiecutter_project/docs/_build/html/index.html".
So, you now have a simple django application. Go forth and code!
"Your Stuff" "Your Stuff"
------------- -------------