Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
astronomerritt authored Feb 16, 2024
1 parent bdc0ace commit 46c3164
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,3 +60,24 @@ Notes:
into documentation for ReadTheDocs works as expected. For more information, see
the Python Project Template documentation on
[Sphinx and Python Notebooks](https://lincc-ppt.readthedocs.io/en/latest/practices/sphinx.html#python-notebooks)

## Dev Guide - Updating pyproject.toml

If you are adding code that requires a new dependency, this needs to be included in pyproject.toml under the `[project]' section:

```
dependencies = [
"ipykernel", # Support for Jupyter notebooks
"numpy",
"lsst-rsp"
"your-dependency-here"
]
```

If you are adding code that should be run from the command line, this should be set up under `[project.scripts]`:

```
[project.scripts]
adler = "adler.adler:main"
my_command = "adler.module_folder.module_name:function_name"
```

0 comments on commit 46c3164

Please sign in to comment.