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

README enhancement

Browse Source
This commit is contained in:
Daniel Greenfeld 2013-08-18 14:44:28 +02:00
parent 9b051ce6ec
commit 6a85835ecc
1 changed files with 49 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
README.rst
View File

@ -23,13 +23,58 @@ Constraints
* PostgreSQL everywhere
* Environment variables for configuration (This won't work with Apache/mod_wsgi)
Using this template
--------------------
Usage
------
.. code-block:: bash
First, get cookiecutter. Trust me, it's awesome::
$ pip install cookiecutter
$ cookiecutter https://github.com/sloria/cookiecutter-dj-project.git
Now run it against this repo::
$ cookiecutter https://github.com/pydanny/cookiecutter-dj-project.git
You'll be prompted for some questions, answer them, then it will create a Django project for you.
Let's pretend you want to create a Django project called "redditclone". Rather than using `startproject`
and then editing the results to include your name, email, and various configuration issues, let's get
cookiecutter_ to do all the work.
**Warning**: After this point, change 'Daniel Greenfeld', 'pydanny', etc to your own information.
It prompts you for questions. Answer them::
Cloning into 'cookiecutter-dj-project'...
remote: Counting objects: 49, done.
remote: Compressing objects: 100% (33/33), done.
remote: Total 49 (delta 6), reused 48 (delta 5)
Unpacking objects: 100% (49/49), done.
full_name (default is "Your full name here")? Daniel Greenfeld
email (default is "you@example.com")? pydanny@gmail.com
project_name (default is "dj-project")? redditclone
repo_name (default is "dj_project")? redditclone
app_name (default is "djproject")? redditclone
project_short_description (default is "Your project description goes here")? A reddit clone.
release_date (default is "2013-08-15")? 2013-08-15
year (default is "2013")? 2013
version (default is "0.1.0")? 0.3.0
Enter the project and take a look around::
$ cd redditclone/
$ ls
Create a GitHub repo and push it there::
$ git init
$ git add .
$ git commit -m "first awesome commit!"
$ git remote add origin git@github.com:pydanny/redditclone.git
$ git push -u origin master
Now take a look at your repo. Awesome, right?
It's time to write the code!!!
"Your Stuff"