Skip to content

Latest commit

 

History

History
113 lines (79 loc) · 3.95 KB

about.md

File metadata and controls

113 lines (79 loc) · 3.95 KB
title abstract authors contributor maintainer repository_code version license_url operating_system programming_language keywords date_released
CMTools
[CodeMeta](https://codemeta.github.io) Tools provides a simple command line tool called `cmt` that can be used to generate project files and software artifacts. It provides a tool called `cme` to edit and manage the CodeMeta file. The project focuses on leveraging CodeMeta data, directory name and Git repo information for building and release software written in Python, Go, JavaScript or TypeScript. It was motivated by the practices in Caltech Library's Digital Development Group. The tools are intended to be run from the project root directory. `cmt` expects the file path of your codemeta.json file as well as one or more target files to be generated. The target file's extension determines the generated content. The tool can generate the following project files based on the contents of the codemeta.json file. `cme` expects the file path of your codemeta.json file and optionally the attributes of the CodeMeta object you wish to manage. `cme` is used to create and manage "codemeta.json". `cmt` is used to generate the following. - README.md - INSTALL.md - installer.sh - installer.ps1 - CITATION.cff - version.ts, version.js, version.go or version.py - about.md - page.hbs (handlebars template) or page.tmpl (Pandoc template)
family_name given_name orcid
Doiel
R. S.
family_name given_name orcid
Morrell
Tom
family_name given_name orcid
Doiel
R. S.
0.0.19
Linux
Windows
macOS
TypeScript
codemeta
cff
software
code generation
2025-03-04

About this software

CMTools 0.0.19

Fixes to generate about.md

Authors

Contributors

Maintainers

CodeMeta Tools provides a simple command line tool called `cmt` that can be used to generate project files and software artifacts. It provides a tool called `cme` to edit and manage the CodeMeta file.

The project focuses on leveraging CodeMeta data, directory name and Git repo information for building and release software written in Python, Go, JavaScript or TypeScript. It was motivated by the practices in Caltech Library's Digital Development Group.

The tools are intended to be run from the project root directory. `cmt` expects the file path of your codemeta.json file as well as one or more target files to be generated. The target file's extension determines the generated content. The tool can generate the following project files based on the contents of the codemeta.json file. `cme` expects the file path of your codemeta.json file and optionally the attributes of the CodeMeta object you wish to manage.

`cme` is used to create and manage "codemeta.json". `cmt` is used to generate the following.

  • README.md

  • INSTALL.md

  • installer.sh

  • installer.ps1

  • CITATION.cff

  • version.ts, version.js, version.go or version.py

  • about.md

  • page.hbs (handlebars template) or page.tmpl (Pandoc template)

  • License: https://data.caltech.edu/LICENSE

  • GitHub: git+https://github.com/caltechlibrary/CMTools

  • Issues: git+https://github.com/caltechlibrary/CMTools/issues

Programming languages

  • TypeScript

Operating Systems

  • Linux
  • Windows
  • macOS

Software Requirements

  • Deno >= 2.1.9
  • GNU Make >= 3.81
  • Pandoc >= 3.1
  • Git >= 2.39
  • CMTools >= 0.0.16