Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
a.pirogov committed Jan 16, 2024
1 parent 33e5304 commit eabf3d1
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 5 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,9 @@ Properly maintaining this kind of information in various files scattered around

### Platform Support

`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.
Starting with version **0.3.0**, `somesy` supports Linux, MacOS and Windows.

Make sure that you use the latest version in order to avoid any problems.

### Installing somesy

Expand Down Expand Up @@ -145,7 +147,7 @@ file in the root folder of your repository:
repos:
# ... (your other hooks) ...
- repo: https://github.com/Materials-Data-Science-and-Informatics/somesy
rev: "v0.2.0"
rev: "v0.3.0"
hooks:
- id: somesy
```
Expand Down
14 changes: 11 additions & 3 deletions docs/manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -372,11 +372,16 @@ after running somesy (to remove the duplicate entries with the incorrect ORCID).

### Codemeta

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


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.
As that `codemeta.json` is a [**JSON-LD**](https://json-ld.org/) file, it actually represents a graph,
has various equally valid representations in a JSON file.
Thus, supporting the same features as for other formats is technically much more
challenging, if at all feasible. Therefore, for the time being, we regenerate the
`codemeta.json` file directly from the source file, in order to avoid data inconsistency
due to many pitfalls hiding in the details of the format.

!!! warning

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

Of course, you are welcome to contribute an improved CodeMeta writer for somesy that can correctly
understand and update the linked data graph which the `codemeta.json` file represents!

## Using somesy to insert metadata into project documentation

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.
Expand Down

0 comments on commit eabf3d1

Please sign in to comment.