Skip to content

Commit 3e40665

Browse files
committed
Updated readme, docs
1 parent f1d8b63 commit 3e40665

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,16 @@ For EPRpy documentation, see [here](https://davistdaniel.github.io/EPRpy/). Sour
3030
* Generate quick plots of 1D and 2D datasets, compare different datasets.
3131
* [Automated processing pipelines](https://davistdaniel.github.io/EPRpy/notebooks/examples.html#Workflows) for specific pulse programs. Read more about [workflows](https://davistdaniel.github.io/EPRpy/workflows.html).
3232

33+
## Contributing
34+
35+
Contributions are very welcome!
36+
37+
* Report issues – If you find a bug, unexpected behavior, or just a typo in the documentation, please let me know or open an issue.
38+
* Submit improvements – Bug fixes, performance tweaks, new features, or cleaner code are always appreciated.
39+
* Improve docs – Clear examples, tutorials, and explanations are as valuable as code contributions.
40+
* Share ideas – Suggestions for new functionality or workflows are great input for shaping the library.
41+
42+
3343
## Limitations
3444
* Supports reading of files only in Bruker BES3T format v.1.2 and upto 2D datasets.
3545

docs/source/index.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,3 +54,10 @@ Using EPRpy
5454
EprData
5555
Examples
5656

57+
.. toctree::
58+
:maxdepth: 1
59+
:caption: References
60+
61+
GitHub <https://github.com/davistdaniel/EPRpy>
62+
PyPi <https://pypi.org/project/eprpy/>
63+

0 commit comments

Comments
 (0)