From f8c0159f6586c021002caa5a87001d653a706dd5 Mon Sep 17 00:00:00 2001 From: megha13-keswani Date: Sun, 8 Mar 2026 19:48:30 +0530 Subject: [PATCH] Docs: add example for creating a package using cookiecutter template --- docs/index.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/index.rst b/docs/index.rst index 1c93b13..01ef28b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -44,6 +44,15 @@ If you would like to stick to simply the cookiecutter approach, the template sti $ pip install cookiecutter $ cookiecutter gh:OpenAstronomy/packaging-guide -o ./output_directory +Example +------- + +You can also directly create a package using the cookiecutter template: + +.. code-block:: bash + + cookiecutter gh:OpenAstronomy/packaging-guide + This will create a new directory in your current directory named the same as the value of "packagename" you supplied. Change into this directory and run ``git init`` to make it into a git repository, and make an initial commit. This is required in order to have software versioning working for your package.