Skip to content

Commit 9c87008

Browse files
update documentation (#94)
* add notes * explain why set some fields as compulsory * Update README.md Co-authored-by: Volker Hofmann <89833997+hofmannv@users.noreply.github.com> --------- Co-authored-by: Volker Hofmann <89833997+hofmannv@users.noreply.github.com>
1 parent 42ae9c2 commit 9c87008

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,10 @@ latest stable version of somesy from PyPI using `pip`:
6565
pip install somesy
6666
```
6767

68+
> **Note**
69+
>
70+
> If you use somesy as a pre-commit hook, you don't have to install somesy on your PC nor add it as a dependency in your Python project. Pre-commit will handle the installation automatically.
71+
6872
### Configuring somesy
6973

7074
Yes, somesy is _another_ tool with its own configuration. However, for your
@@ -107,6 +111,8 @@ publication_author = true
107111
verbose = true # show detailed information about what somesy is doing
108112
```
109113

114+
As Helmholtz Metadata Collaboration (HMC), our goal is to increase usage of metadata and improve metadata quality. Therefore, some fields in `somesy.toml` are set as required fields. This is to increase rigour and completeness of metadata recorded with `somesy` .
115+
110116
<!-- --8<-- [end:somesytoml] -->
111117

112118
Alternatively, you can also add the somesy configuration to an existing
@@ -164,6 +170,10 @@ repos:
164170
- id: somesy
165171
```
166172
173+
> **Note**
174+
>
175+
> Please add the latest version of Somesy to your project. You can update the version of Somesy in your config file now and later to use the newest versions as they become available.
176+
167177
Note that `pre-commit` gives `somesy` the [staged](https://git-scm.com/book/en/v2/Getting-Started-What-is-Git%3F) version of files,
168178
so when using `somesy` with pre-commit, keep in mind that
169179

0 commit comments

Comments
 (0)