Skip to content

Commit d08d699

Browse files
authored
Fix typo and formatting in README.md (#59)
Signed-off-by: Arthit Suriyawongkul <[email protected]>
1 parent d194b69 commit d08d699

File tree

2 files changed

+7
-9
lines changed

2 files changed

+7
-9
lines changed

AUTHORS

-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
Copyright (C) 2019 The Software Heritage developers
22

33
See http://www.softwareheritage.org/ for more information.
4-

README.md

+7-8
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ CodeMeta documents (aka. `codemeta.json`).
66
The [CodeMeta initiative](https://github.com/codemeta/codemeta) is a Free and Open Source academic collaboration
77
creating a minimal metadata schema for research software and code.
88

9-
The academic community recommands on adding a codemeta.json file in
9+
The academic community recommends on adding a codemeta.json file in
1010
the root directory of your repository.
1111

1212
With this linked data metadata file, you can easily declare the authorship,
@@ -16,7 +16,7 @@ data, etc.).
1616
Also, the `codemeta.json` file in your source code is indexed in the
1717
Software Heritage (SWH) archive, which will improve findability in searches.
1818

19-
### References
19+
## References
2020

2121
- [SWH guidelines](https://www.softwareheritage.org/save-and-reference-research-software/) for research software.
2222

@@ -33,7 +33,7 @@ Software Heritage (SWH) archive, which will improve findability in searches.
3333

3434
1. create a complete codemeta.json file from scratch
3535
2. aggregate existing information and add complementary information to
36-
a codemeta.json file
36+
a codemeta.json file
3737

3838
### Functionalities
3939

@@ -49,7 +49,7 @@ This tool was initially prepared for the [FORCE19 Hackathon](https://github.com/
4949

5050
**NB:** codemeta v2.0 is generated by default, but v3.0 (v2.0 compatible) can be generated via a dedicated button.
5151

52-
## Code contributions.
52+
## Code contributions
5353

5454
This section only applies to developers who want to contribute to the Codemeta Generator.
5555
If you only want to use it, you can use
@@ -71,7 +71,7 @@ files (nginx, apache2, etc.).
7171

7272
The simplest way is probably to use Python's HTTP server:
7373

74-
```
74+
```shell
7575
git clone https://github.com/codemeta/codemeta-generator
7676
cd codemeta-generator
7777
python3 -m http.server
@@ -86,18 +86,17 @@ quickly, using [Cypress](https://www.cypress.io/).
8686

8787
To run them, first install Cypress:
8888

89-
```
89+
```shell
9090
sudo apt install npm # or the equivalent on your system
9191
npx [email protected] install
9292
```
9393

9494
Then, run the tests:
9595

96-
```
96+
```shell
9797
9898
```
9999

100-
101100
## Contributed by
102101

103102
![Image description](https://annex.softwareheritage.org/public/logo/software-heritage-logo-title-motto.svg)

0 commit comments

Comments
 (0)