You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-2Lines changed: 4 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,7 +53,9 @@ Properly maintaining this kind of information in various files scattered around
53
53
54
54
### Platform Support
55
55
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.
57
59
58
60
### Installing somesy
59
61
@@ -145,7 +147,7 @@ file in the root folder of your repository:
Copy file name to clipboardExpand all lines: docs/manual.md
+11-3Lines changed: 11 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -372,11 +372,16 @@ after running somesy (to remove the duplicate entries with the incorrect ORCID).
372
372
373
373
### Codemeta
374
374
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,
376
377
[CodeMeta](https://codemeta.github.io/) is implemented differently.
377
378
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.
380
385
381
386
!!! warning
382
387
@@ -386,6 +391,9 @@ Other formats implement person identification and merging, but for codemeta.json
386
391
As `codemeta.json` is considered a technical "backend-format" derived from other
387
392
inputs, in most cases you probably do not need or should edit it by hand anyway.
388
393
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
+
389
397
## Using somesy to insert metadata into project documentation
390
398
391
399
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