about.html

<!DOCTYPE html>
<html lang="en-US">
<head>
    <title>CMTools</title>
    <link rel="stylesheet" href="/css/site.css">
</head>
<body>
<nav>
<ul>
    <li><a href="/">Home</a></li>
    <li><a href="index.html">README</a></li>
    <li><a href="LICENSE">LICENSE</a></li>
    <li><a href="INSTALL.html">INSTALL</a></li>
    <li><a href="user_manual.html">User Manual</a></li>
    <li><a href="about.html">About</a></li>
    <li><a href="search.html">Search</a></li>
    <li><a href="https://github.com/caltechlibrary/CMTools">GitHub</a></li>
</ul>
</nav>
<section>
<h1 id="about-this-software">About this software</h1>
<h2 id="cmtools-0.0.24">CMTools 0.0.24</h2>
<p>Fixed duplicate copyrightYear and copyrightHolder handling.</p>
<h3 id="authors">Authors</h3>
<ul>
<li>R. S. Doiel, <a href="https://orcid.org/0000-0003-0900-6903"
class="uri">https://orcid.org/0000-0003-0900-6903</a></li>
</ul>
<h3 id="contributors">Contributors</h3>
<ul>
<li>Tom Morrell, <a href="https://orcid.org/0000-0001-9266-5146"
class="uri">https://orcid.org/0000-0001-9266-5146</a></li>
</ul>
<h3 id="maintainers">Maintainers</h3>
<ul>
<li>R. S. Doiel, <a href="https://orcid.org/0000-0003-0900-6903"
class="uri">https://orcid.org/0000-0003-0900-6903</a></li>
</ul>
<p><a href="https://codemeta.github.io">CodeMeta</a> 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.</p>
<p>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.</p>
<p>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.</p>
<p>`cme` is used to create and manage "codemeta.json". `cmt` is used to
generate the following.</p>
<ul>
<li><p>README.md</p></li>
<li><p>INSTALL.md</p></li>
<li><p>installer.sh</p></li>
<li><p>installer.ps1</p></li>
<li><p>CITATION.cff</p></li>
<li><p>version.ts, version.js, version.go or version.py</p></li>
<li><p>about.md</p></li>
<li><p>page.hbs (handlebars template) or page.tmpl (Pandoc
template)</p></li>
<li><p>License: <a
href="https://caltechlibrary.github.io/CMTools/LICENSE"
class="uri">https://caltechlibrary.github.io/CMTools/LICENSE</a></p></li>
<li><p>GitHub:
&lt;git+https://github.com/caltechlibrary/CMTools&gt;</p></li>
<li><p>Issues:
&lt;git+https://github.com/caltechlibrary/CMTools/issues&gt;</p></li>
</ul>
<h3 id="programming-languages">Programming languages</h3>
<ul>
<li>TypeScript</li>
</ul>
<h3 id="operating-systems">Operating Systems</h3>
<ul>
<li>Linux</li>
<li>Windows</li>
<li>macOS</li>
</ul>
<h3 id="software-requirements">Software Requirements</h3>
<ul>
<li>Deno &gt;= 2.1.9</li>
<li>GNU Make &gt;= 3.81</li>
<li>Pandoc &gt;= 3.1</li>
<li>Git &gt;= 2.39</li>
<li>CMTools &gt;= 0.0.20</li>
</ul>
</section>
</body>
</html>