代码元生成器

此存储库包含要生成的（客户端）web应用程序CodeMeta文档（又名。代码元.json).

这个CodeMeta倡议是一个自由开放源代码的学术合作为研究软件和代码创建最小的元数据模式。

学术界建议在存储库的根目录。

使用此链接数据元数据文件，您可以轻松声明作者身份，包括上下文信息和其他研究成果的链接（出版物、，数据等）。

此外代码元.json源代码中的文件在软件遗产（SWH）档案，这将提高搜索的可查找性。

工具书类

• SWH指南用于研究软件。

• SWH博客帖子关于元数据索引。

• Dan S.Katz的博客帖子关于包括存储库中的元数据。

• FORCE11软件引用实施工作组储存库

• RDA和FORCE11联合软件源代码识别工作组储存库

规格

用例

1. 从头开始创建完整的codemeta.json文件
2. 聚合现有信息并将补充信息添加到codemeta.json文件

功能

• 填写表单时的帮助程序，例如spdx的引用列表许可证
• 提交后的验证机制
• 使用所有codeMeta术语和schema.org术语的可能性
• 可从多个平台（web浏览器或操作系统）访问
• （额外）验证后纠正输出的可能性创建过程的

此工具最初是为FORCE19黑客马拉松.

代码贡献。

本节仅适用于希望为Codemeta Generator做出贡献的开发人员。如果你只想使用它，你可以使用托管版本而不是。

规范指南

此应用程序设计用于流行的现代浏览器（Firefox、，Chromium/Google Chrome、Edge、Safari）。检查卡尼乌斯了解这些浏览器功能的可用性。

为了保持架构简单，我们直接将javascript文件提供给浏览器，没有编译器或转发器；并且不使用第三方依赖关系。

运行本地更改

要运行Codemeta Generator，只需要一个HTTP服务器为文件（nginx、apache2等）。

最简单的方法可能是使用Python的HTTP服务器：

git克隆https://github.com/codemeta/codemeta-generator网站cd代码元生成器python3-m http.server

然后打开http://localhost:8000/在您的web浏览器中。

自动测试

除了手动测试外，我们还进行了自动化测试以检查错误快速，使用柏树.

要运行它们，请首先安装Cypress：

sudo apt安装npm或系统上的等效程序npm安装柏树$（npm bin）/cypress安装

然后，运行测试：

$（npm箱）/柏树运行

贡献者