Convert README from RestructuredText to Markdown

README.md

@@ -0,0 +1,80 @@
+# Cookiecutter Poetry
+
+[![Release](https://img.shields.io/github/v/release/fpgmaas/cookiecutter-poetry)](https://pypi.org/project/cookiecutter-poetry/)
+[![Build status](https://img.shields.io/github/workflow/status/fpgmaas/cookiecutter-poetry/merge-to-main)](https://img.shields.io/github/workflow/status/fpgmaas/cookiecutter-poetry/merge-to-main)
+[![Supported Python versions](https://img.shields.io/pypi/pyversions/cookiecutter-poetry)](https://pypi.org/project/cookiecutter-poetry/)
+[![Docs](https://img.shields.io/badge/docs-gh--pages-blue)](https://fpgmaas.github.io/cookiecutter-poetry/)
+[![Commit activity](https://img.shields.io/github/commit-activity/m/fpgmaas/cookiecutter-poetry)](https://img.shields.io/github/commit-activity/m/fpgmaas/cookiecutter-poetry)
+[![License](https://img.shields.io/github/license/fpgmaas/cookiecutter-poetry)](https://img.shields.io/github/license/fpgmaas/cookiecutter-poetry)
+
+
+This is a [cookiecutter](https://github.com/cookiecutter/cookiecutter)
+repository to generate the file structure for a Python project that uses
+[Poetry](https://python-poetry.org/) for its dependency management.
+
+- **Documentation**: [Link](https://fpgmaas.github.io/cookiecutter-poetry/)
+- **Example repository**: [Link](https://github.com/fpgmaas/cookiecutter-poetry-example)
+- **PyPi**: [Link](https://pypi.org/project/cookiecutter-poetry/)
+
+## Features
+
+- [Poetry](https://python-poetry.org/), obviously.
+- CI/CD with [GitHub Actions](https://github.com/features/actions)
+- Formatting with [black](https://pypi.org/project/black/) and [isort](https://pycqa.github.io/isort/index.html)
+- Publishing to [Pypi](https://pypi.org) or [Artifactory](https://jfrog.com/artifactory) by creating a new release on GitHub
+- Testing with [pytest](https://docs.pytest.org/en/7.1.x/)
+- Documentation with [MkDocs](https://www.mkdocs.org/)
+- Compatibility testing for multiple versions of Python with [Tox](https://tox.wiki/en/latest/)
+
+## Example CI/CD Pipeline
+
+[![Example pipeline](https://raw.githubusercontent.com/fpgmaas/cookiecutter-poetry/main/static/images/pipeline.png)](https://raw.githubusercontent.com/fpgmaas/cookiecutter-poetry/main/static/images/pipeline.png)
+
+## Quickstart
+
+On your local machine, navigate to the directory in which you want to
+create a project directory, and run the following two commands:
+
+``` bash
+pip install cookiecutter-poetry 
+ccp
+```
+
+Alternatively, install `cookiecutter` and directly pass the URL to this
+Github repository to the `cookiecutter` command:
+
+``` bash
+pip install cookiecutter
+cookiecutter https://github.com/fpgmaas/cookiecutter-poetry.git
+```
+
+Then run the following commands, replacing `<project-name>`, with the
+name that you also gave the Github repository and
+`<github_author_handle>` with your Github username.
+
+``` bash
+cd <project_name>
+git init -b main
+git add .
+git commit -m "Init commit"
+git remote add origin [email protected]:<github_author_handle>/<project_name>.git
+git push -u origin main
+```
+
+Finally, install the environment with `make install`.
+
+You are now ready to start development on your project! The CI/CD
+pipeline will be triggered when you open a pull request, merge to main,
+or when you create a new release.
+
+To finalize the set-up for publishing to PyPi or Artifactory, see
+[here](https://fpgmaas.github.io/cookiecutter-poetry/features/publishing/#set-up-for-pypi).
+For activating the automatic documentation with MkDocs, see
+[here](https://fpgmaas.github.io/cookiecutter-poetry/features/mkdocs/#enabling-the-documentation-on-github).
+
+## Acknowledgements
+
+This project is partially based on [Audrey
+Feldroy\'s](https://github.com/audreyfeldroy)\'s great
+[cookiecutter-pypackage](https://github.com/audreyfeldroy/cookiecutter-pypackage)
+repository.

docs/index.md

@@ -15,10 +15,10 @@ A project generated with ``cookiecutter-poetry`` supports the following features
 - [Poetry](https://python-poetry.org/), obviously.
 - CI/CD with [GitHub Actions](https://github.com/features/actions)
 - Formatting with [black](https://pypi.org/project/black/) and [isort](https://pycqa.github.io/isort/index.html)
-- Publishing to [Pypi](https://pypi.org) or [Artifactory](https://jfrog.com/artifactory) by creating a new release on GitHub.
+- Publishing to [Pypi](https://pypi.org) or [Artifactory](https://jfrog.com/artifactory) by creating a new release on GitHub
 - Testing with [pytest](https://docs.pytest.org/en/7.1.x/)
 - Documentation with [MkDocs](https://www.mkdocs.org/)
-- Compatibility testing with [Tox](https://tox.wiki/en/latest/)
+- Compatibility testing for multiple versions of Python with [Tox](https://tox.wiki/en/latest/)
 
 An example of a repository generated with this package can be found [here](https://github.com/fpgmaas/cookiecutter-poetry-example).
 
@@ -57,7 +57,7 @@ Finally, install the environment with `make install`.
 
 You are now ready to start development on your project! The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release. 
 
-To finalize the set-up for publishing to PyPi or Artifactory through CI/CD, see [here](./features/publishing.md#set-up-for-pypi). For activating the automatic documentation with MkDocs, see [here](./features/mkdocs.md#enabling-the-documentation-on-github). 
+To finalize the set-up for publishing to PyPi or Artifactory, see [here](./features/publishing.md#set-up-for-pypi). For activating the automatic documentation with MkDocs, see [here](./features/mkdocs.md#enabling-the-documentation-on-github). 
 
 ## Acknowledgements
 

pyproject.toml

@@ -5,7 +5,7 @@ description = "A python cookiecutter application to create a new python project
 authors = ["Florian Maas <[email protected]>"]
 repository = "https://github.com/fpgmaas/cookiecutter-poetry"
 documentation = "https://fpgmaas.github.io/cookiecutter-poetry/"
-readme = "README.rst"
+readme = "README.md"
 keywords = ['cookiecutter', 'template', 'poetry']
 packages = [
   {include = "cookiecutter_poetry"}