pkgs/sage-project-cookiecutter/README.rst: Document using --overwrite…

…-if-exists
sagemath · Mar 19, 2024 · 6fd5d25 · 6fd5d25
1 parent b73d4e2
commit 6fd5d25
Showing 1 changed file with 6 additions and 3 deletions.
diff --git a/pkgs/sage-project-cookiecutter/README.rst b/pkgs/sage-project-cookiecutter/README.rst
@@ -66,16 +66,19 @@ Adding Sage CI portability/integration testing infrastructure to an upstream pro
 
    $ sage-project-cookiecutter create --upstream-package PROJECT-DIRECTORY
 
-Creates:
+Creates in the existing ``PROJECT-DIRECTORY``:
 
 - ``.github/workflows/ci-sage.yml``
 - ``.devcontainer/portability-*``
 - ``.devcontainer/tox-docker-in-docker``
 
 It can also be invoked as follows::
 
-   $ pipx run cruft create https://github.com/mkoeppe/sage --checkout sagemath-environment-cookiecutter \
-       --directory="pkgs/sage-project-cookiecutter/sage_project_cookiecutter/upstream-package-template"
+   [alice@localhost PROJECT-DIRECTORY]$ (cd .. && pipx run cruft create \
+       https://github.com/mkoeppe/sage --checkout sagemath-environment-cookiecutter \
+       --directory="pkgs/sage-project-cookiecutter/sage_project_cookiecutter/upstream-package-template" \
+       --overwrite-if-exists)
+   [1/1] Name of the project (directory name to create) (my-sage-project): PROJECT-DIRECTORY
 
 
 Creating a pip-installable upstream package of the SageMath organization