From d2b6a0a28fcedc92d0a64f061a611f5285bbc714 Mon Sep 17 00:00:00 2001 From: Daniel Huppmann Date: Tue, 23 Feb 2021 09:15:17 +0100 Subject: [PATCH 1/5] Add reference to `choosealicense.com` --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6b24f97..685ee83 100644 --- a/README.md +++ b/README.md @@ -18,8 +18,10 @@ Detailed instructions to create a new repository from a template can be found Then, make the following changes: -0. Change the text of the `LICENSE` file (optional). -0. Update the url in the license badge in this readme to point to the new repository. +0. Change the text of the [LICENSE](LICENSE) file (optional). + Visit [choosealicense.com](https://choosealicense.com) to find out which license is + right for your project. +0. Update the url in the license badge in this readme to point to your new repository. 0. Rename the folder `python_stub` to the intended package name. 0. Update the package name, author info and url in `setup.cfg`. 0. Update the package name, author info and copyright in `doc/source/conf.py`. From b349e0156d0b39c1ba58912c06d79dc6f9b2a2f0 Mon Sep 17 00:00:00 2001 From: Daniel Huppmann Date: Tue, 23 Feb 2021 09:15:36 +0100 Subject: [PATCH 2/5] Fix instructions for building the docs --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 685ee83..24cd1d2 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ Install the package including the requirements for building the docs. ## Building the docs -Navigate to the doc folder and run Sphinx. +Run Sphinx to build the docs! make --directory=doc html From 295ebcbcfddd596e35e6e1834508d13361c783d1 Mon Sep 17 00:00:00 2001 From: Daniel Huppmann Date: Tue, 23 Feb 2021 09:15:48 +0100 Subject: [PATCH 3/5] Rewrite reference to cookiecutter --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 24cd1d2..f292d6c 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,8 @@ A GitHub Action workflow is configured to check that your commits conform to the We recommend that you follow the [numpydoc](https://numpydoc.readthedocs.io) docstring formatting guide. -Looking for more ideas to include fancy modules in your package? +Looking for more best-practice tools for scientific software development +in your package? Take a look at the [cookiecutter-hypermodern-python](https://github.com/cjolowicz/cookiecutter-hypermodern-python) repository! ## Installation From e73c63b79c5d07095457a544c3b8a035a7c3e95b Mon Sep 17 00:00:00 2001 From: Daniel Huppmann Date: Tue, 23 Feb 2021 09:53:23 +0100 Subject: [PATCH 4/5] Add instruction to change the copyright --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index f292d6c..1b50a45 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,9 @@ Then, make the following changes: 0. Change the text of the [LICENSE](LICENSE) file (optional). Visit [choosealicense.com](https://choosealicense.com) to find out which license is right for your project. +0. Update the copyright (if other than IIASA) in this readme. 0. Update the url in the license badge in this readme to point to your new repository. + This will automatically change the license badge (if you changed the license). 0. Rename the folder `python_stub` to the intended package name. 0. Update the package name, author info and url in `setup.cfg`. 0. Update the package name, author info and copyright in `doc/source/conf.py`. From 9e0741a04b693ab587b0a5d83d3edadb2af755e9 Mon Sep 17 00:00:00 2001 From: Daniel Huppmann Date: Tue, 23 Feb 2021 09:56:15 +0100 Subject: [PATCH 5/5] Make recommendations more concise --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 1b50a45..2aad922 100644 --- a/README.md +++ b/README.md @@ -39,8 +39,7 @@ A GitHub Action workflow is configured to check that your commits conform to the We recommend that you follow the [numpydoc](https://numpydoc.readthedocs.io) docstring formatting guide. -Looking for more best-practice tools for scientific software development -in your package? +Looking for more best-practice tools for scientific software development? Take a look at the [cookiecutter-hypermodern-python](https://github.com/cjolowicz/cookiecutter-hypermodern-python) repository! ## Installation