Skip to content

Typo: recommands -> recommends #59

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
merged 1 commit into from
Jan 2, 2025
Merged

Typo: recommands -> recommends #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 0 additions & 1 deletion AUTHORS
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
Copyright (C) 2019 The Software Heritage developers

See http://www.softwareheritage.org/ for more information.

15 changes: 7 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ CodeMeta documents (aka. `codemeta.json`).
The [CodeMeta initiative](https://github.com/codemeta/codemeta) is a Free and Open Source academic collaboration
creating a minimal metadata schema for research software and code.

The academic community recommands on adding a codemeta.json file in
The academic community recommends on adding a codemeta.json file in
the root directory of your repository.

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

### References
## References

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

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

1. create a complete codemeta.json file from scratch
2. aggregate existing information and add complementary information to
a codemeta.json file
a codemeta.json file

### Functionalities

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

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

## Code contributions.
## Code contributions

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

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

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

To run them, first install Cypress:

```
```shell
sudo apt install npm # or the equivalent on your system
npx [email protected] install
```

Then, run the tests:

```
```shell
npx [email protected] run
```


## Contributed by

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