Skip to content

Commit b31d379

Browse files
authored
Codemeta -> CodeMeta (#63)
1 parent 130a962 commit b31d379

File tree

5 files changed

+17
-17
lines changed

5 files changed

+17
-17
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1-
# Codemeta Generator
1+
# CodeMeta Generator
22

33
This repository contains a (client-side) web application to generate
44
CodeMeta documents (aka. `codemeta.json`).
55

6-
The [CodeMeta initiative](https://github.com/codemeta/codemeta) is a Free and Open Source academic collaboration
6+
The [CodeMeta initiative](https://github.com/codemeta/codemeta)
7+
is a Free and Open Source academic collaboration
78
creating a minimal metadata schema for research software and code.
89

910
The academic community recommends on adding a codemeta.json file in
@@ -19,13 +20,12 @@ Software Heritage (SWH) archive, which will improve findability in searches.
1920
## References
2021

2122
- [SWH guidelines](https://www.softwareheritage.org/save-and-reference-research-software/) for research software.
22-
2323
- [SWH blog post](https://www.softwareheritage.org/2019/05/28/mining-software-metadata-for-80-m-projects-and-even-more/) about metadata indexation.
2424
- [Dan S. Katz's blog post](https://danielskatzblog.wordpress.com/2017/09/25/software-heritage-and-repository-metadata-a-software-citation-solution/) about including
2525
metadata in your repository.
2626
- FORCE11's Software Citation Implementation WG [repository](https://github.com/force11/force11-sciwg)
2727
- RDA & FORCE11's joint Software Source Code Identification WG
28-
[repository](https://github.com/force11/force11-rda-scidwg)
28+
[repository](https://github.com/force11/force11-rda-scidwg)
2929

3030
## Specifications
3131

@@ -37,21 +37,21 @@ Software Heritage (SWH) archive, which will improve findability in searches.
3737

3838
### Functionalities
3939

40-
- helpers while completing the form, for example a reference list of spdx
40+
- helpers while completing the form, for example a reference list of SDPX
4141
licenses
4242
- a validation mechanism after submission
43-
- the possibility to use all the codeMeta terms and schema.org terms
43+
- the possibility to use all the CodeMeta terms and Schema.org terms
4444
- accessible from multiple platforms (web browsers or OS)
4545
- (extra) the possibility to correct the output after validation as part
4646
of the creation process
4747

4848
This tool was initially prepared for the [FORCE19 Hackathon](https://github.com/force11/force11-rda-scidwg/tree/master/hackathon/FORCE2019).
4949

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

5252
## Code contributions
5353

54-
This section only applies to developers who want to contribute to the Codemeta Generator.
54+
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
5656
[the hosted version](https://codemeta.github.io/codemeta-generator/) instead.
5757

@@ -61,12 +61,12 @@ This application is designed to work on popular modern browsers (Firefox,
6161
Chromium/Google Chrome, Edge, Safari). Check [Caniuse](https://caniuse.com/)
6262
for availability of features for these browsers.
6363

64-
To keep the architecture simple, we serve javascript files directly to
64+
To keep the architecture simple, we serve JavaScript files directly to
6565
browsers, without a compiler or transpiler.
6666

6767
### Running local changes
6868

69-
To run Codemeta Generator, you just need an HTTP server serving the
69+
To run CodeMeta Generator, you just need an HTTP server serving the
7070
files (nginx, apache2, etc.).
7171

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

codemeta.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030

3131
/* This file contains extra CSS, that isn't needed for the application to be
3232
* usable, but it makes it more welcoming, and reuses a style similar to
33-
* Codemeta's main website.
33+
* CodeMeta's main website.
3434
*/
3535

3636
body {

codemeta.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"dateCreated": "2019-10-02",
77
"issueTracker": "https://github.com/codemeta/codemeta-generator/issues",
88
"continuousIntegration": "https://travis-ci.org/codemeta/codemeta-generator/",
9-
"name": "Codemeta Generator",
9+
"name": "CodeMeta Generator",
1010
"keywords": ["codemeta", "metadata", "json"],
1111
"author": [
1212
{

index.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,13 @@ <h1>CodeMeta generator v3.0</h1>
2626

2727
<main>
2828

29-
<p>Most fields are optional. Mandatory fields will be highlighted when generating Codemeta.</p>
29+
<p>Most fields are optional. Mandatory fields will be highlighted when generating CodeMeta.</p>
3030

3131
<noscript>
3232
<p id="noscriptError">
33-
This application requires Javascript to show dynamic fields in the form,
34-
and generate a JSON file; but your browser does not support Javascript.
35-
If you cannot use a browser with Javascript support, you can try
33+
This application requires JavaScript to show dynamic fields in the form,
34+
and generate a JSON file; but your browser does not support JavaScript.
35+
If you cannot use a browser with JavaScript support, you can try
3636
<a href="https://codemeta.github.io/tools/">one of the other available tools</a>
3737
or write the codemeta.json file directly.
3838
</p>

js/validation/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
*/
77

88
/*
9-
* Reads a Codemeta file and shows human-friendly errors on it.
9+
* Reads a CodeMeta file and shows human-friendly errors on it.
1010
*
1111
* This validator intentionaly does not use a schema, in order to show errors
1212
* that are easy to understand for users with no understanding of JSON-LD.

0 commit comments

Comments
 (0)