From de551c9bbd591e6c9c53712fdb21f41f7fc0e661 Mon Sep 17 00:00:00 2001 From: Lance Edgar Date: Tue, 3 Dec 2024 09:31:43 -0600 Subject: [PATCH] docs: cleanup quickstart a bit, add some links --- docs/narr/install/quickstart.rst | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/docs/narr/install/quickstart.rst b/docs/narr/install/quickstart.rst index 0fea804..84a491d 100644 --- a/docs/narr/install/quickstart.rst +++ b/docs/narr/install/quickstart.rst @@ -22,35 +22,39 @@ Make a parent folder for all source code: mkdir -p ~/src -Make a :term:`virtual environment` for your project: +Make and activate a new :term:`virtual environment` for your project: .. code-block:: sh cd /path/to/envs python3 -m venv poser + source poser/bin/activate Make a new e.g. ``poser`` database in PostgreSQL (or MySQL). -Install and run cookiecutter with wuttaweb template: +Install and run `cookiecutter `_ +with `wuttaweb template +`_: .. code-block:: sh - cd /path/to/envs/poser - bin/pip install cookiecutter - bin/cookiecutter -o ~/src git+https://forgejo.wuttaproject.org/wutta/cookiecutter-wuttaweb + pip install cookiecutter + cookiecutter -o ~/src git+https://forgejo.wuttaproject.org/wutta/cookiecutter-wuttaweb Assuming you now have project code at ``~/src/poser`` then install -that and run the app installer: +that and run the app installer. Note the 2nd command name will depend +on your project: .. code-block:: sh - bin/pip install -e ~/src/poser - bin/poser install + pip install -e ~/src/poser + poser install If all goes well, you can run the web app with: .. code-block:: sh + cd /path/to/envs/poser bin/pserve --reload file+ini:app/web.conf And browse it at http://localhost:9080