Skip to content

Commit 98990d2

Browse files
authored
Merge pull request #4 from sarnold/more-readme
Improve readme
2 parents ed9f354 + 547745b commit 98990d2

File tree

1 file changed

+20
-14
lines changed

1 file changed

+20
-14
lines changed

README.rst

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,36 @@ Python project using simple setuptools project config; note package
55
data, scripts, entry points, etc, **all still work** using pyproject.toml
66
per `setuptools documentation`_.
77

8+
To create a new repository using this template, click the button labeled
9+
**Use this template** and select **Create a new repository**.
10+
811
|ci| |wheels| |bandit| |release|
912

1013
|pre| |cov| |pylint|
1114

1215
|tag| |license| |reuse| |python|
1316

14-
To use this template, replace the example project name with your own:
17+
After creating your repository, replace the example project name "simple"
18+
with your own:
1519

1620
* change the project name at the top of ``pyproject.toml``
1721
* change the project name in ``docs/source/conf.py`` *and* ``docs/source/index.rst``
1822
* change the author details in ``pyproject.toml`` *and* ``docs/source/conf.py``
1923
* change the package directory name under the ``src`` folder
2024
* change the github URL paths in ``pyproject.toml``
2125

26+
Make a ``badges`` branch
27+
------------------------
28+
29+
Create an orphan branch for Pylint and Coverage workflows. In a fresh
30+
checkout, run the following commands::
31+
32+
$ git checkout --orphan badges
33+
$ git reset --hard
34+
$ git commit --allow-empty -m "Initializing badges branch"
35+
$ git push origin badges
36+
$ git checkout main
37+
2238

2339
.. _setuptools documentation: https://setuptools.pypa.io/en/latest/userguide/package_discovery.html
2440

@@ -79,19 +95,6 @@ extra features:
7995
status checks
8096

8197

82-
Make a ``badges`` branch
83-
------------------------
84-
85-
Create an orphan branch for Pylint and Coverage workflows. In a fresh
86-
checkout, run the following commands::
87-
88-
$ git checkout --orphan badges
89-
$ git reset --hard
90-
$ git commit --allow-empty -m "Initializing badges branch"
91-
$ git push origin badges
92-
$ git checkout main
93-
94-
9598
Dev tools
9699
=========
97100

@@ -141,6 +144,9 @@ To build/lint the api docs, use the following tox commands:
141144
* ``tox -e cdocs`` run ``make clean`` in the docs build
142145

143146

147+
Gitchangelog
148+
------------
149+
144150
We use gitchangelog_ to generate a changelog and/or release notes, as
145151
well as the gitchangelog message format to help it categorize/filter
146152
commits for tidier output. Please use the appropriate ACTION modifiers

0 commit comments

Comments
 (0)