diff --git a/.gitignore b/.gitignore index df1440d..ca80399 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ newapp.sh newapp.sh~ +README.md~ diff --git a/README.md b/README.md new file mode 100644 index 0000000..19249ad --- /dev/null +++ b/README.md @@ -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