add getting started parameter and fix refer to the correct contribution guidelines

Author: ahms5

copier.yml

@@ -7,6 +7,10 @@ project_long_description:
     help: "A long description of the project"
     default: ""
 
+project_getting_started:
+    type: str
+    help: "A short description of how to get started with the project"
+
 git_username:
     type: str
     help: "The GitHub username or organization name"

template/README.md.jinja

@@ -7,23 +7,13 @@
 [![CircleCI](https://circleci.com/gh/{{ git_username }}/{{ project_slug | replace("_", "-") }}.svg?style=shield)](https://circleci.com/gh/{{ git_username }}/{{ project_slug | replace("_", "-") }})
 [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/pyfar/gallery/main?labpath=docs/gallery/interactive/pyfar_introduction.ipynb)
 
-
 {{ project_long_description }}
 
-Getting Started
-===============
+## Getting Started
 
-The [pyfar workshop](https://mybinder.org/v2/gh/pyfar/gallery/main?labpath=docs/gallery/interactive/pyfar_introduction.ipynb)
-gives an overview of the most important pyfar functionality and is a good
-starting point. It is part of the [pyfar example gallery](https://pyfar-gallery.readthedocs.io/en/latest/examples_gallery.html)
-that also contains more specific and in-depth
-examples that can be executed interactively without a local installation by
-clicking the mybinder.org button on the respective example. The
-[pyfar documentation](https://pyfar.readthedocs.io) gives a detailed and complete overview of pyfar. All
-these information are available from [pyfar.org](https://pyfar.org).
+{{ project_getting_started }}
 
-Installation
-============
+## Installation
 
 Use pip to install {{ project_slug }}
 
@@ -33,7 +23,6 @@ Use pip to install {{ project_slug }}
 
 If the installation fails, please check out the [help section](https://pyfar-gallery.readthedocs.io/en/latest/help).
 
-Contributing
-============
+## Contributing
 
-Check out the [contributing guidelines](https://pyfar.readthedocs.io/en/stable/contributing.html) if you want to become part of pyfar.
+Check out the [contributing guidelines](https://{{ project_slug }}.readthedocs.io/en/stable/contributing.html) if you want to become part of pyfar.

tests/conftest.py

@@ -5,6 +5,7 @@ def copier_project_defaults():
     return {
         "project_slug": "my_project",
         "project_long_description": "my_project_description",
+        "project_getting_started": "This is how to get started with my_project.",
         "git_username": "pyfar",
         "minimum_python_version": "3.11",
         }

tests/test_copier.py

@@ -26,6 +26,8 @@ def test_generated_file_exists(copie, copier_project_defaults, file_name):
     "main/docs/resources/logos/pyfar_logos_fixed_size_my_project.png",
     "Python 3.11 or higher",
     "py/my_project.svg",
+    "https://my_project.readthedocs.io/en/stable/contributing.html",
+    "\nThis is how to get started with my_project.\n",
 ])
 def test_content_readme(copie, copier_project_defaults, desired):
     project = copie.copy(extra_answers=copier_project_defaults)