Skip to content

Commit 39682fe

Browse files
committed
Update README.md to include Contributing, License, Changelog, and Acknowledgements sections
1 parent 458e8cb commit 39682fe

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@ This guide provides practical examples for common use cases with the pydeepskylo
1818
- [Contrast Reserve](#contrast-reserve)
1919
- [Optimal Detection Magnification](#optimal-detection-magnification)
2020
- [Magnitudes](#magnitudes)
21+
- [Contributing](#contributing)
22+
- [License](#license)
23+
- [Changelog](#changelog)
24+
- [Acknowledgements](#acknowledgements)
2125

2226
---
2327

@@ -38,6 +42,12 @@ Install via pip:
3842
pip install pydeepskylog
3943
```
4044

45+
Development dependencies can be installed with:
46+
47+
```bash
48+
pip install -e .[dev]
49+
```
50+
4151
## Basic Usage
4252

4353
Import the main modules:
@@ -189,6 +199,10 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute.
189199

190200
[GPL-3.0](LICENSE)
191201

202+
## Changelog
203+
204+
See [CHANGELOG.md](CHANGELOG.md) for a detailed list of changes and updates to the package.
205+
192206
## Acknowledgements
193207

194208
This package is inspired by the [DeepskyLog](https://www.deepskylog.org/) website and the code is based on the formulas used in DeepskyLog. We would like to thank the DeepskyLog developers team.

0 commit comments

Comments
 (0)