-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathINSTALL.html
More file actions
104 lines (104 loc) · 4.79 KB
/
INSTALL.html
File metadata and controls
104 lines (104 loc) · 4.79 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
<!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>
<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="installation-for-development-of-cmtools">Installation for
development of <strong>CMTools</strong></h1>
<p><strong>CMTools</strong> <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>README.md</li>
<li>INSTALL.md</li>
<li>installer.sh</li>
<li>installer.ps1</li>
<li>CITATION.cff</li>
<li>version.ts, version.js, version.go or version.py</li>
<li>about.md</li>
<li>page.tmpl (Pandoc template) or page.hbs (handlebars template)</li>
<li>Makefile (for Go or Deno based projects)</li>
<li>website.mak</li>
<li>release.bash</li>
<li>publish.bash</li>
</ul>
<h2 id="quick-install-with-curl-or-irm">Quick install with curl or
irm</h2>
<p>There is an experimental installer.sh script that can be run with the
following command to install latest table release. This may work for
macOS, Linux and if you’re using Windows with the Unix subsystem. This
would be run from your shell (e.g. Terminal on macOS).</p>
<pre class="shell"><code>curl https://caltechlibrary.github.io/CMTools/installer.sh | sh</code></pre>
<p>This will install the programs included in CMTools in your
<code>$HOME/bin</code> directory.</p>
<p>If you are running Windows 10 or 11 use the Powershell command
below.</p>
<div class="sourceCode" id="cb2"><pre
class="sourceCode ps1"><code class="sourceCode powershell"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="fu">irm</span> https<span class="op">://</span>caltechlibrary<span class="op">.</span><span class="fu">github</span><span class="op">.</span><span class="fu">io</span><span class="op">/</span>CMTools<span class="op">/</span>installer<span class="op">.</span><span class="fu">ps1</span> <span class="op">|</span> <span class="fu">iex</span></span></code></pre></div>
<h3 id="if-your-are-running-macos-or-windows">If your are running macOS
or Windows</h3>
<p>You may get security warnings if you are using macOS or Windows. See
the notes for the specific operating system you’re using to fix
issues.</p>
<ul>
<li><a href="INSTALL_NOTES_macOS.html">INSTALL_NOTES_macOS.md</a></li>
<li><a
href="INSTALL_NOTES_Windows.html">INSTALL_NOTES_Windows.md</a></li>
</ul>
<h2 id="installing-from-source">Installing from source</h2>
<h3 id="required-software">Required software</h3>
<ul>
<li>Deno >= 2.4.3</li>
<li>CMTools >= 0.0.37</li>
</ul>
<h3 id="steps">Steps</h3>
<ol type="1">
<li>git clone https://github.com/caltechlibrary/CMTools</li>
<li>Change directory into the <code>CMTools</code> directory</li>
<li>Make to build, test and install</li>
</ol>
<pre class="shell"><code>git clone https://github.com/caltechlibrary/CMTools
cd CMTools
make
make test
make install</code></pre>
</section>
<footer-global></footer-global>
</body>
</html>