alex/cookiecutter
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Reformat readme

Browse source
This commit is contained in:
Alexander Wainwright 2024-05-20 19:01:31 +10:00
parent 3c5905cb85
commit d25d4c116f
1 changed files with 15 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -1,7 +1,8 @@
cookiecutter-pypackage-minimal
==============================
An opinionated, minimal [cookiecutter](https://github.com/audreyr/cookiecutter) template for Python packages, and some guidelines for Python packaging.
An opinionated, minimal [cookiecutter](https://github.com/audreyr/cookiecutter)
template for Python packages, and some guidelines for Python packaging.
Usage
-----
@ -10,9 +11,13 @@ Usage
git clone https://github.com/kragniz/cookiecutter-pypackage-minimal.git
cookiecutter cookiecutter-pypackage-minimal/
You should then change the classifiers in `{{ package_name }}/pyproject.toml` - it is assumed that the project will run on the latest versions of Python 2 and 3, so you should remove any classifiers that do not apply. The full list of PyPI classifiers can be found [here](https://pypi.org/classifiers/).
You should then change the classifiers in `{{ package_name }}/pyproject.toml` -
it is assumed that the project will run on the latest versions of Python 2 and
3, so you should remove any classifiers that do not apply. The full list of PyPI
classifiers can be found [here](https://pypi.org/classifiers/).
Fill out the README, and - if necessary - [choose a license](https://choosealicense.com/) for the project.
Fill out the README, and - if necessary - [choose a
license](https://choosealicense.com/) for the project.
Explanation
-----------
@ -22,9 +27,12 @@ The decisions `cookiecutter-pypackage-minimal` makes should all be explained her
### README
* **README should use reStructuredText format**
This is the format used by most Python tools, is expected by [setuptools](https://setuptools.readthedocs.io), and can be used by [Sphinx](http://sphinx-doc.org/).
This is the format used by most Python tools, is expected by
[setuptools](https://setuptools.readthedocs.io), and can be used by
[Sphinx](http://sphinx-doc.org/).
* **As few README files as possible**
Additional README files (AUTHORS, CHANGELOG, etc) should be left to the user to create when necessary.
Additional README files (AUTHORS, CHANGELOG, etc) should be left to the user
to create when necessary.
### LICENSE
@ -32,4 +40,5 @@ The decisions `cookiecutter-pypackage-minimal` makes should all be explained her
This template provides you the GPLv3 licence.
You can [choose another license](https://choosealicense.com/).
* **A license is a requirement**
Nowadays, people who want to use your library/application want to make sure they can do it legally.
Nowadays, people who want to use your library/application want to make sure
they can do it legally.