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

Update docs

Browse Source 
Signed-off-by: Andrew-Chen-Wang <acwangpython@gmail.com>
This commit is contained in:
Andrew-Chen-Wang 2022-11-22 13:39:59 -05:00
parent a3f03ccdc0
commit 59c1c8e83a
2 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -108,6 +108,10 @@ Answer the prompts with your own desired [options](http://cookiecutter-django.re
author_name [Daniel Roy Greenfeld]: Daniel Greenfeld author_name [Daniel Roy Greenfeld]: Daniel Greenfeld
domain_name [example.com]: myreddit.com domain_name [example.com]: myreddit.com
email [daniel-greenfeld@example.com]: pydanny@gmail.com email [daniel-greenfeld@example.com]: pydanny@gmail.com
Select username_type:
1 - username
2 - email
Choose from 1, 2 [1]: 1
version [0.1.0]: 0.0.1 version [0.1.0]: 0.0.1
Select open_source_license: Select open_source_license:
1 - MIT 1 - MIT

7
docs/project-generation-options.rst
View File

@ -24,6 +24,13 @@ author_name:
email: email:
The email address you want to identify yourself in the project. The email address you want to identify yourself in the project.
username_type:
The type of username you want to use in the project. This can be either
``username`` or ``email``. If you choose ``username``, the ``email`` field
will be included. If you choose ``email``, the ``username`` field will be
excluded. It is best practice to always include an email field, so there is
no option for having just the ``username`` field.
domain_name: domain_name:
The domain name you plan to use for your project once it goes live. The domain name you plan to use for your project once it goes live.
Note that it can be safely changed later on whenever you need to. Note that it can be safely changed later on whenever you need to.