Added new parameters, adjusted the README.md, conftest.py and test_copier.py files

Author: h-chmeruk

copier.yml

@@ -20,6 +20,20 @@ project_getting_started:
     type: str
     help: "A short description of how to get started with the project"
 
+project_installation_instructions:
+    type: str
+    help: "A short description of how to install the package. It will be added to the README.md of this project"
+
+add_reference_section:
+  type: bool
+  help: "Do you want to add a reference section to the README.md?"
+  default: false
+
+reference_section_description:
+  when: "{{ add_reference_section }}"
+  type: str
+  help: "Enter the references for the reference section."
+
 git_username:
     type: str
     help: "The GitHub username or organization name"

template/README.md.jinja

@@ -23,6 +23,15 @@ Use pip to install {{ project_slug }}
 
 If the installation fails, please check out the [help section](https://pyfar-gallery.readthedocs.io/en/latest/help).
 
+{{ project_installation_instructions }}
+
 ## Contributing
 
 Check out the [contributing guidelines](https://{{ project_slug }}.readthedocs.io/en/stable/contributing.html) if you want to become part of pyfar.
+
+{% if add_reference_section == true -%}
+## References
+
+{{ reference_section_description }}
+
+{%- endif %}

tests/conftest.py

@@ -6,6 +6,9 @@ def copier_project_defaults():
         "project_slug": "my_project",
         "project_long_description": "my_project_description",
         "project_getting_started": "This is how to get started.",
+        "add_reference_section": "Y",
+        "project_installation_instructions": "Installation instructions.",
+        "reference_section_description": "Reference section description.",
         "git_username": "pyfar",
         "minimum_python_version": "3.11",
         "license": "MIT",

tests/test_copier.py

@@ -48,6 +48,8 @@ def test_generated_file_exists(default_project, file_name):
     "py/my_project.svg",
     "https://my_project.readthedocs.io/en/stable/contributing.html",
     "\nThis is how to get started.\n",
+    "\nInstallation instructions.\n",
+    "\n\n## References\n\nReference section description.",
 ])
 def test_content_readme(default_project, desired):
     content = default_project.project_dir.joinpath("README.md").read_text()