add README with quick start
This commit is contained in:
parent
46b33a622f
commit
e4aa3a402f
1
.gitignore
vendored
1
.gitignore
vendored
|
@ -1,2 +1,3 @@
|
|||
newapp.sh
|
||||
newapp.sh~
|
||||
README.md~
|
||||
|
|
21
README.md
Normal file
21
README.md
Normal file
|
@ -0,0 +1,21 @@
|
|||
|
||||
# cookiecutter-wuttaweb
|
||||
|
||||
Template to generate project code for a new app based on
|
||||
[WuttaWeb](https://wuttaproject.org).
|
||||
|
||||
|
||||
## Quick Start
|
||||
|
||||
Install cookiecutter to your virtual environment:
|
||||
|
||||
pip install cookiecutter
|
||||
|
||||
Run it with the URL to template:
|
||||
|
||||
cookiecutter git+https://forgejo.wuttaproject.org/wutta/cookiecutter-wuttaweb
|
||||
|
||||
Or clone the template and run with local copy:
|
||||
|
||||
git clone https://forgejo.wuttaproject.org/wutta/cookiecutter-wuttaweb
|
||||
cookiecutter ./cookiecutter-wuttaweb
|
Loading…
Reference in a new issue