Skip to content

Commit 450acb3

Browse files
authored
Update user-guide.md (#49)
- Add JSON code highlighting to all JSON snippets - Replace a deprecated license ID (`GPL-3.0`) in Array example with one of the updated ones (`GPL-3.0-or-later`) - Add a link to git tag in the release candidate reference recommendation
1 parent 452c526 commit 450acb3

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

content/user-guide.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ title: user guide
66

77
You can use the [codemeta-generator](https://codemeta.github.io/codemeta-generator/) directly at <https://codemeta.github.io/codemeta-generator/>
88

9-
## Creating A CodeMeta Instance File Manually
9+
## Creating a CodeMeta instance file manually
1010

1111
A CodeMeta instance file describes the metadata associated with a software object using JSON's linked data (JSON-LD) notation. A codemeta file can contain any of the properties described on the [CodeMeta terms page](/terms/). Most codemeta files are called `codemeta.json` by convention.
1212

13-
Here is an example of a basic `codemeta.json` that you can put at the root of a Github repo ([link to full example](https://github.com/ropensci/codemetar/blob/master/codemeta.json)):
13+
Here is an example of a basic `codemeta.json` that you can put at the root of a GitHub repo ([link to full example](https://github.com/ropensci/codemetar/blob/master/codemeta.json)):
1414

1515
```json
1616
{
@@ -55,7 +55,7 @@ All fields that accept a value of a given type accept an array of values of this
5555

5656
```json
5757
"license": [
58-
"https://spdx.org/licenses/GPL-3.0",
58+
"https://spdx.org/licenses/GPL-3.0-or-later",
5959
"https://spdx.org/licenses/BSD-3-Clause"
6060
]
6161
```
@@ -213,7 +213,7 @@ appropriate context file, e.g.
213213
"@context": "https://doi.org/10.5063/schema/codemeta-2.0"
214214
```
215215

216-
Release candidate versions may be referred to consistently using their git tag for the raw version, e.g. <https://raw.githubusercontent.com/codemeta/codemeta/2.0-rc/codemeta.jsonld>. *Please do not refer to the raw GitHub URL for the master branch*, as this is subject to change and will not guarantee a stable metadata file.
216+
Release candidate versions may be referred to consistently using their [git tag](https://github.com/codemeta/codemeta/tags) for the raw version, e.g. <https://raw.githubusercontent.com/codemeta/codemeta/2.0-rc/codemeta.jsonld>. *Please do not refer to the raw GitHub URL for the master branch*, as this is subject to change and will not guarantee a stable metadata file.
217217

218218
## Testing An Instance file
219219

0 commit comments

Comments
 (0)