From e4aa3a402f85829d5de1c43ab63872ff69bb9ce8 Mon Sep 17 00:00:00 2001 From: Lance Edgar Date: Tue, 26 Nov 2024 11:28:19 -0600 Subject: [PATCH] add README with quick start --- .gitignore | 1 + README.md | 21 +++++++++++++++++++++ 2 files changed, 22 insertions(+) create mode 100644 README.md 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