Skip to content

Commit 589dff8

Browse files
Add steps to the setup instructions and fix details to build the docs (#5)
1 parent 53bc906 commit 589dff8

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,12 @@ Detailed instructions to create a new repository from a template can be found
1818

1919
Then, make the following changes:
2020

21-
0. Change the text of the `LICENSE` file (optional).
22-
0. Update the url in the license badge in this readme to point to the new repository.
21+
0. Change the text of the [LICENSE](LICENSE) file (optional).
22+
Visit [choosealicense.com](https://choosealicense.com) to find out which license is
23+
right for your project.
24+
0. Update the copyright (if other than IIASA) in this readme.
25+
0. Update the url in the license badge in this readme to point to your new repository.
26+
This will automatically change the license badge (if you changed the license).
2327
0. Rename the folder `python_stub` to the intended package name.
2428
0. Update the package name, author info and url in `setup.cfg`.
2529
0. Update the package name, author info and copyright in `doc/source/conf.py`.
@@ -35,7 +39,7 @@ A GitHub Action workflow is configured to check that your commits conform to the
3539
We recommend that you follow the [numpydoc](https://numpydoc.readthedocs.io)
3640
docstring formatting guide.
3741

38-
Looking for more ideas to include fancy modules in your package?
42+
Looking for more best-practice tools for scientific software development?
3943
Take a look at the [cookiecutter-hypermodern-python](https://github.com/cjolowicz/cookiecutter-hypermodern-python) repository!
4044

4145
## Installation
@@ -46,7 +50,7 @@ Install the package including the requirements for building the docs.
4650

4751
## Building the docs
4852

49-
Navigate to the doc folder and run Sphinx.
53+
Run Sphinx to build the docs!
5054

5155
make --directory=doc html
5256

0 commit comments

Comments
 (0)