Skip to content

Commit 2ab9bb3

Browse files
authored
Merge pull request #472 from lincc-frameworks/issue/459/setup-dev-changes
Set .setup_dev.sh script to be executable, and edit Readme to tell folks to run it.
2 parents 5fb640b + f779928 commit 2ab9bb3

File tree

2 files changed

+3
-5
lines changed

2 files changed

+3
-5
lines changed

python-project-template/.setup_dev.sh

100644100755
File mode changed.

python-project-template/README.md.jinja

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,19 +37,17 @@ Once you have created a new environment, you can install this project for local
3737
development using the following commands:
3838

3939
```
40-
>> pip install -e .'[dev]'
41-
>> pre-commit install
40+
>> ./.setup_dev.sh
4241
>> conda install pandoc
4342
```
4443

4544
Notes:
46-
1. The single quotes around `'[dev]'` may not be required for your operating system.
47-
2. `pre-commit install` will initialize pre-commit for this local repository, so
45+
1. `./.setup_dev.sh` will initialize pre-commit for this local repository, so
4846
that a set of tests will be run prior to completing a local commit. For more
4947
information, see the Python Project Template documentation on
5048
[pre-commit](https://lincc-ppt.readthedocs.io/en/latest/practices/precommit.html)
5149
{%- if include_notebooks %}
52-
3. Install `pandoc` allows you to verify that automatic rendering of Jupyter notebooks
50+
2. Install `pandoc` allows you to verify that automatic rendering of Jupyter notebooks
5351
into documentation for ReadTheDocs works as expected. For more information, see
5452
the Python Project Template documentation on
5553
[Sphinx and Python Notebooks](https://lincc-ppt.readthedocs.io/en/latest/practices/sphinx.html#python-notebooks)

0 commit comments

Comments
 (0)