From aff3f430b0c003ec5c37fff7a3fc4f95924663a0 Mon Sep 17 00:00:00 2001 From: Jeremy Kubica <104161096+jeremykubica@users.noreply.github.com> Date: Fri, 10 Mar 2023 16:21:47 -0500 Subject: [PATCH] Add the license question to the introduction --- docs/source/new_project.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/source/new_project.rst b/docs/source/new_project.rst index b3eccda1..1d991b62 100644 --- a/docs/source/new_project.rst +++ b/docs/source/new_project.rst @@ -17,6 +17,7 @@ Copier will ask you questions for how to set up the project. These questions wil * *What is your python module name?* (``module_name``): The name of your (first) module. The main thing this controls is where your source code will live (``src/{{module_name}}``). * *Your first and last name?* (``author_name``): The name of code's author. This will be used in the project and documentation metadata. * *Your preferred email address?* (``author_email``): The contact email for the code's author. This will be used in the project and documentation metadata. + * *What license would you like to use?* (``project_license``): The license type you wwant to use for this project. Options are MIT and BSD. For more information on these options see `Github's license page `_. * *What tooling would you like to use to enforce code style?* (``preferred_linter``): A linter is a tool to automatically format for consistency (see :doc:`Linting <../practices/linting>`). We provide options for `black `_, `pylint `_, or no linter. Choosing a linter will include it as a project dependency and include it in the :doc:`pre-commit <../practices/precommit>` hooks. * *Do you want to use a tool to maintain a specific ordering for module imports?* (``use_isort``): `isort `_ is a tool for ordering imports in a standard order. Enabling the option will include ``isort`` as part of github's :doc:`pre-commit <../practices/precommit>`. * *Do you want to create some example module code?* (``create_example_module``): If this option is selected the template will create a model in ``src/{{module_name}}`` and create a corresponding example test file.