@@ -6,7 +6,7 @@ CodeMeta documents (aka. `codemeta.json`).
6
6
The [ CodeMeta initiative] ( https://github.com/codemeta/codemeta ) is a Free and Open Source academic collaboration
7
7
creating a minimal metadata schema for research software and code.
8
8
9
- The academic community recommands on adding a codemeta.json file in
9
+ The academic community recommends on adding a codemeta.json file in
10
10
the root directory of your repository.
11
11
12
12
With this linked data metadata file, you can easily declare the authorship,
@@ -16,7 +16,7 @@ data, etc.).
16
16
Also, the ` codemeta.json ` file in your source code is indexed in the
17
17
Software Heritage (SWH) archive, which will improve findability in searches.
18
18
19
- ### References
19
+ ## References
20
20
21
21
- [ SWH guidelines] ( https://www.softwareheritage.org/save-and-reference-research-software/ ) for research software.
22
22
@@ -33,7 +33,7 @@ Software Heritage (SWH) archive, which will improve findability in searches.
33
33
34
34
1 . create a complete codemeta.json file from scratch
35
35
2 . aggregate existing information and add complementary information to
36
- a codemeta.json file
36
+ a codemeta.json file
37
37
38
38
### Functionalities
39
39
@@ -49,7 +49,7 @@ This tool was initially prepared for the [FORCE19 Hackathon](https://github.com/
49
49
50
50
** NB:** codemeta v2.0 is generated by default, but v3.0 (v2.0 compatible) can be generated via a dedicated button.
51
51
52
- ## Code contributions.
52
+ ## Code contributions
53
53
54
54
This section only applies to developers who want to contribute to the Codemeta Generator.
55
55
If you only want to use it, you can use
@@ -71,7 +71,7 @@ files (nginx, apache2, etc.).
71
71
72
72
The simplest way is probably to use Python's HTTP server:
73
73
74
- ```
74
+ ``` shell
75
75
git clone https://github.com/codemeta/codemeta-generator
76
76
cd codemeta-generator
77
77
python3 -m http.server
@@ -86,18 +86,17 @@ quickly, using [Cypress](https://www.cypress.io/).
86
86
87
87
To run them, first install Cypress:
88
88
89
- ```
89
+ ``` shell
90
90
sudo apt install npm # or the equivalent on your system
91
91
92
92
```
93
93
94
94
Then, run the tests:
95
95
96
- ```
96
+ ``` shell
97
97
98
98
```
99
99
100
-
101
100
## Contributed by
102
101
103
102
![ Image description] ( https://annex.softwareheritage.org/public/logo/software-heritage-logo-title-motto.svg )
0 commit comments