Skip to content

Commit 1c3bf41

Browse files
committed
hints to technical documentation in README and CONTRIBUTING.md
1 parent 7355e40 commit 1c3bf41

2 files changed

Lines changed: 4 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ Thank you for your interest! Contributions of all kinds are welcome.
55

66
## PR TODO list - your first PR
77

8+
To understand how the library is structured as well the technical details before diving in, you can first read the [developer documentation](docs/overview.md), and/or you can also read the docstrings of the modules and classes that you are working on.
9+
810
Use this checklist to stay on track for your first code PR:
911

1012
- **Clone this repository**: see [Set up developer environment](#set-up-developer-environment) section.

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ and the Siamese Neural Networks.
2626
7. [License](#license)
2727
8. [References](#references)
2828

29+
For a technical deep-dive into the library internals, see the [developer documentation](docs/overview.md).
30+
2931
## Why `pyvisim`?
3032

3133
`pyvisim` is designed to provide a simple and efficient way to compare images.

0 commit comments

Comments
 (0)