Skip to content

Commit eabf3d1

Browse files
author
a.pirogov
committed
update readme
1 parent 33e5304 commit eabf3d1

2 files changed

Lines changed: 15 additions & 5 deletions

File tree

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,9 @@ Properly maintaining this kind of information in various files scattered around
5353

5454
### Platform Support
5555

56-
`somesy` is now compatible with MacOS, Ubuntu, and Windows. For Windows users, it's important to use a version `0.3.0` or higher of somesy to ensure compatibility.
56+
Starting with version **0.3.0**, `somesy` supports Linux, MacOS and Windows.
57+
58+
Make sure that you use the latest version in order to avoid any problems.
5759

5860
### Installing somesy
5961

@@ -145,7 +147,7 @@ file in the root folder of your repository:
145147
repos:
146148
# ... (your other hooks) ...
147149
- repo: https://github.com/Materials-Data-Science-and-Informatics/somesy
148-
rev: "v0.2.0"
150+
rev: "v0.3.0"
149151
hooks:
150152
- id: somesy
151153
```

docs/manual.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -372,11 +372,16 @@ after running somesy (to remove the duplicate entries with the incorrect ORCID).
372372

373373
### Codemeta
374374

375-
While `somesy` is modifying existing files for most supported formats,
375+
While `somesy` is modifying existing files for most supported formats and implements
376+
features such as person identification and merging,
376377
[CodeMeta](https://codemeta.github.io/) is implemented differently.
377378

378-
379-
Other formats implement person identification and merging, but for codemeta.json, there's a notable exception: person data gets overwritten by the source file. Given that `codemeta.json` is a `JSON-LD file`, it inherently represents data as a graph, allowing for diverse information storage methods. To navigate this complexity and ensure accurate data representation, we opt to regenerate the `codemeta.json` file directly from the source file.
379+
As that `codemeta.json` is a [**JSON-LD**](https://json-ld.org/) file, it actually represents a graph,
380+
has various equally valid representations in a JSON file.
381+
Thus, supporting the same features as for other formats is technically much more
382+
challenging, if at all feasible. Therefore, for the time being, we regenerate the
383+
`codemeta.json` file directly from the source file, in order to avoid data inconsistency
384+
due to many pitfalls hiding in the details of the format.
380385

381386
!!! warning
382387

@@ -386,6 +391,9 @@ Other formats implement person identification and merging, but for codemeta.json
386391
As `codemeta.json` is considered a technical "backend-format" derived from other
387392
inputs, in most cases you probably do not need or should edit it by hand anyway.
388393

394+
Of course, you are welcome to contribute an improved CodeMeta writer for somesy that can correctly
395+
understand and update the linked data graph which the `codemeta.json` file represents!
396+
389397
## Using somesy to insert metadata into project documentation
390398

391399
While `somesy` can synchronize structured metadata files and formats, there is a common case that cannot be covered by the `sync` command - when project metadata should appear in plain text documents, such as documentation files and web pages.

0 commit comments

Comments
 (0)