Skip to content

Commit a937e16

Browse files
committed
Reestructure README headers
This gives a better grouping of information, which hopefully makes it easier to find. Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 8fd4440 commit a937e16

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Frequenz repository common configuration for Python
22

3+
## Introduction
4+
35
This is very opinionated set of tools and configurations to setup a Python
46
repository for [Frequenz](https://frequenz.com) projects.
57

@@ -13,7 +15,9 @@ If offers:
1315

1416
[Cookiecutter]: https://cookiecutter.readthedocs.io/en/stable
1517

16-
## Start a new project
18+
## Usage
19+
20+
### Start a new project
1721

1822
To start a new project you should first [install
1923
Cookiecutter](https://cookiecutter.readthedocs.io/en/stable/installation.html).
@@ -47,7 +51,7 @@ After completing it and fixing the `TODO`s you can amend the previous commit
4751
using `git commit --amend` or create a new commit for the changes using `git
4852
commit`.
4953

50-
### Create the local development environment
54+
#### Create the local development environment
5155

5256
To start the development, you need to make sure your environment is correctly
5357
setup. One way to do this is by using a virtual environment and installing all
@@ -66,7 +70,7 @@ you can open a python interpreter and import your package modules and pick up
6670
any local changes without the need to reinstall. You can now run tools
6771
directly, like `pytest`.
6872

69-
### Verify the new repository is healthy using `nox`
73+
#### Verify the new repository is healthy using `nox`
7074

7175
If you prefer to keep your virtual enviroment cleaner and avoid installing development dependencies, you can also use `nox` to create isolated environments for you:
7276

@@ -89,7 +93,7 @@ which will run linters and tests.
8993
Otherwise `nox` will create many virtual environments each time you run it,
9094
which is **very** slow.
9195

92-
### Verify the generated documentation works
96+
#### Verify the generated documentation works
9397

9498
To generate the documentation you can use `mkdocs`:
9599

@@ -110,7 +114,7 @@ point your browser to Now you can point your browser to
110114
`.proto`](https://github.com/pseudomuto/protoc-gen-doc) files is using
111115
`docker`.
112116

113-
### Initialize the GitHub pages website
117+
#### Initialize the GitHub pages website
114118

115119
The generated documentation can be easily published via GitHub pages, and it
116120
will be automatically updated for new pushed and releases, but for that to work
@@ -129,7 +133,7 @@ Then make sure that GitHub pages is enabled in
129133
If all went well, your website should be available soon via
130134
`https://<repo-owner>.github.io//<repo-name>/`.
131135

132-
## Migrate an existing project
136+
### Migrate an existing project
133137

134138
The easiest way to migrate an existing project is to just generate a new one
135139
basing all the inputs in the current project metadata and then overwritting the
@@ -165,7 +169,7 @@ git commit -a
165169
project](#create-the-local-development-environment) section to finish the
166170
setup.
167171

168-
## Update an existing project
172+
### Update an existing project
169173

170174
To update an existing project you can use the [Cookiecutter *replay
171175
file*](https://cookiecutter.readthedocs.io/en/stable/advanced/replay.html) that

0 commit comments

Comments
 (0)