Skip to content

Commit 8f852fd

Browse files
authored
Update README.md
1 parent 6a6c539 commit 8f852fd

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ This is a basic template for a Python repository, including:
1111
To make a new Python repo (or codespace) using this template:
1212
1) Click on 'Use this template' button at the top-right of the GitHub page.
1313
2) In your new repo, rename (search and replace) all instances of 'py_template' with the name for your package.
14-
3) You can also update the `authors` field in `pyproject.toml` with your name(s) and email(s), and you can update `LICENSE.rst` as you like.
14+
3) You can also update the `authors` field in `pyproject.toml` with your name(s) and email(s), and you can update `LICENSE.rst` as you like. This template is partially based on the `OpenAstronomy packaging guide <https://github.com/OpenAstronomy/packaging-guide>`_, so please retain that aspect of the license.
1515
4) Update the changelog in `HISTORY.rst` when you're ready to release your first version of the code!
1616

1717
After cloning your repo to your local machine, from the project's local root directory, you can:
1818
- Install your package with all optional dependencies:
1919
`pip install -e ".[all]"`
20-
- Run your tests (from the project's root directory):
20+
- Run your tests:
2121
`pytest`
2222
- Build your docs:
2323
`tox -e build_docs`

0 commit comments

Comments
 (0)