Skip to content

Commit 9ab65a8

Browse files
committed
update docs
1 parent 9857704 commit 9ab65a8

2 files changed

Lines changed: 16 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ Please consult the changelog to inform yourself about breaking changes and secur
99
- make validation of output files, such as pyproject.toml, optional
1010
- make somesy project metadata input `version` optional
1111
- multiple output file support
12+
- enable having packages support
13+
- fix: package.json url set error on None value
1214

1315
## [v0.6.0](https://github.com/Materials-Data-Science-and-Informatics/somesy/tree/v0.6.0) <small>(2025-02-14)</small> { id="0.6.0" }
1416

docs/manual.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -293,3 +293,17 @@ The example above shows a project with a `package.json` file in the root folder
293293
!!! note
294294

295295
Let's remember `somesy` will create a `CITATION.CFF` and `codemeta.json` file in the root folder if it is set otherwise either by cli or by config.
296+
297+
#### Packages (sub-modules) with their own somesy file
298+
299+
A project with multiple packages inside can have completely different metadata such version and authors. Therefore, each package should have a separate metadata, in other words, separate `somesy` config and project metadata.
300+
301+
```toml
302+
[project]
303+
...
304+
305+
[config]
306+
packages = ['package1', 'package2', 'package3']
307+
```
308+
309+
Each of these packages (sub-folders) are assumed to have separate somesy metadata in the folder. These packages could be a `somesy` supported language/framework or it could be any other language. `somesy` will create at least `CITATION.CFF` and `codemeta.json` regardless if not instructed otherwise.

0 commit comments

Comments
 (0)