Skip to content

user-guide.md: Update license ID + make heading casing consistent #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
progval merged 2 commits into from
Oct 1, 2025
Merged

user-guide.md: Update license ID + make heading casing consistent #49

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a48810
Update user-guide.md
bact Feb 13, 2024
2abe8c0
Merge branch 'master' into patch-1
bact Oct 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions content/user-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ title: user guide

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

## Creating A CodeMeta Instance File Manually
## Creating a CodeMeta instance file manually

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.

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)):
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)):

```json
{
Expand Down Expand Up @@ -55,7 +55,7 @@ All fields that accept a value of a given type accept an array of values of this

```json
"license": [
"https://spdx.org/licenses/GPL-3.0",
"https://spdx.org/licenses/GPL-3.0-or-later",
"https://spdx.org/licenses/BSD-3-Clause"
]
```
Expand Down Expand Up @@ -213,7 +213,7 @@ appropriate context file, e.g.
"@context": "https://doi.org/10.5063/schema/codemeta-2.0"
```

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

## Testing An Instance file

Expand Down