Skip to content

Commit 76dfba6

Browse files
monperruscboettig
authored andcommitted
add basic example to getting started (#16)
* add basic example to getting started * fix broken link
1 parent 2c6eb69 commit 76dfba6

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

content/user-guide.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,17 @@ title: user guide
66

77
## Creating A CodeMeta Instance File
88

9-
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/).
9+
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.
10+
11+
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://ropensci.github.io/codemetar/articles/codemeta-intro.html)):
12+
```json
13+
{
14+
"@context": ["http://schema.org", {"author": {"@id": "schema:author", "@container": "@list"} } ] ,
15+
"name": "Generate CodeMeta Metadata for R Packages",
16+
"description": "Codemeta defines a 'JSON-LD' format for describing software metadata. This package provides utilities to generate, parse, and modify codemeta.jsonld files automatically for R packages.",
17+
"identifier": "http://dx.doi.org/10.5281/zenodo.XXXX"
18+
}
19+
```
1020

1121

1222
When creating a CodeMeta document, note that they contain JSON name ("property" in linked-data), value pairs where the values can be simple values, arrays or JSON objects. A simple value is a number, string, or one the literal values *false*, *null* *true*, for example:

0 commit comments

Comments
 (0)