-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathabout.html
More file actions
128 lines (128 loc) · 4.87 KB
/
Copy pathabout.html
File metadata and controls
128 lines (128 loc) · 4.87 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
<!DOCTYPE html>
<html lang="en-US">
<head>
<title>CMTools</title>
<link rel="stylesheet" href="https://caltechlibrary.github.io/css/site.css">
<link rel="stylesheet" href="https://media.library.caltech.edu/cl-webcomponents/css/code-blocks.css">
<script type="module" src="https://media.library.caltech.edu/cl-webcomponents/copyToClipboard.js"></script>
<script type="module" src="https://media.library.caltech.edu/cl-webcomponents/footer-global.js"></script>
</head>
<body>
<header>
<a href="https://library.caltech.edu"><img src="https://media.library.caltech.edu/assets/caltechlibrary-logo.png" alt="Caltech Library logo"></a>
</header>
<a href="#main-content" class="visually-hidden">skip to main content</a>
<nav>
<ul>
<li><a href="/">All Library Apps</a></li>
<li><a href="index.html">Home</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">Code Repository</a></li>
</ul>
</nav>
<section id="main-content">
<h1 id="about-this-software">About this software</h1>
<h2 id="cmtools-0.0.46">CMTools 0.0.46</h2>
<ul>
<li>Added global configuration system (~/.cmtoolsrc): profiles,
licenses, person lists</li>
<li>New <code>cme</code> flags: –profiles, –person-lists,
–apply-license, –global-config</li>
<li>New <code>--init</code> sub-types for Deno projects: deno-cli,
deno-bundle, deno-es-module, deno-webcomponent</li>
<li>Added non-programming project types: –init documentation, –init
presentation</li>
<li>Executable names now persisted to project-level .cmtoolsrc for
seamless re-generation</li>
<li>Refactored format registration: FormatGenerator/registerGenerator
pattern in transform.ts</li>
<li>Separate page templates for Caltech Library org vs personal/other
projects</li>
<li>Added
<footer>
to personal page template for A11y compliance</li>
<li>Fixed Makefile generation for Go programs</li>
<li>Fixed Makefile and make.ps1 generation for deno-cli projects</li>
</ul>
<h2 id="authors">Authors</h2>
<ul>
<li><a href="https://orcid.org/0000-0003-0900-6903">R. S. Doiel</a></li>
</ul>
<h2 id="contributors">Contributors</h2>
<ul>
<li><a href="https://orcid.org/0000-0001-9266-5146">Tom Morrell</a></li>
</ul>
<h2 id="maintainers">Maintainers</h2>
<ul>
<li><a href="https://orcid.org/0000-0003-0900-6903">R. S. Doiel</a></li>
</ul>
<p><a href="https://codemeta.github.io">CodeMeta</a> Tools provides a
simple command line tool called <code>cmt</code> that can be used to
generate project files and software artifacts. It provides a tool called
<code>cme</code> 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.
<code>cmt</code> 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.
<code>cme</code> expects the file path of your codemeta.json file and
optionally the attributes of the CodeMeta object you wish to manage.</p>
<p><code>cme</code> is used to create and manage “codemeta.json”.
<code>cmt</code> 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.tmpl (Pandoc template) or page.hbs (handlebars
template)</p></li>
<li><p>site.css</p></li>
<li><p>Makefile (for Go or Deno based projects)</p></li>
<li><p>website.mak</p></li>
<li><p>release.bash</p></li>
<li><p>publish.bash</p></li>
<li><p><a
href="https://caltechlibrary.github.io/CMTools/LICENSE">License</a></p></li>
<li><p><a href="git+https://github.com/caltechlibrary/CMTools">Code
Repository</a></p>
<ul>
<li><a href="git+https://github.com/caltechlibrary/CMTools/issues">Issue
Tracker</a></li>
</ul></li>
</ul>
<h2 id="programming-languages">Programming languages</h2>
<ul>
<li>TypeScript</li>
</ul>
<h2 id="operating-systems">Operating Systems</h2>
<ul>
<li>Linux</li>
<li>Windows</li>
<li>macOS</li>
</ul>
<h2 id="software-requirements">Software Requirements</h2>
<ul>
<li>Deno >= 2.8</li>
<li>CMTools >= 0.0.46</li>
</ul>
<h2 id="software-suggestions">Software Suggestions</h2>
<ul>
<li>GNU Make >= 3.81</li>
<li>Pandoc >= 3.9</li>
<li>Git >= 2.39</li>
</ul>
</section>
<footer-global></footer-global>
</body>
</html>