forked from rsdoiel/mkpage
-
Notifications
You must be signed in to change notification settings - Fork 1
/
install.html
341 lines (339 loc) · 6.83 KB
/
install.html
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
<!DOCTYPE html>
<html>
<head>
<title>Caltech Library's Digital Library Development Sandbox</title>
<link rel="stylesheet" href="/css/site.css">
</head>
<body>
<header>
<a href="http://library.caltech.edu"><img src="/assets/liblogo.gif" 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.html">LICENSE</a>
</li>
<li>
<a href="install.html">INSTALL</a>
</li>
<li>
<a href="docs/">Documentation</a>
</li>
<li>
<a href="how-to/">HOW TO</a>
</li>
<li>
<a href="RELEASE-NOTES.html">Release Notes</a>
</li>
<li>
<a href="about.html">About</a>
</li>
<li>
<a href="https://github.com/caltechlibrary/mkpage">Github</a>
</li>
</ul>
</nav>
<section>
<h1 id="installation">
Installation
</h1>
<p>
<strong>MkPage Project</strong> is a set of command line programs run
from a shell like Bash. NOTE: <em>mkpage</em> depends on <a
href="https://pandoc.org/installing.html">Pandoc</a> (>= v3).
</p>
<h2 id="quick-install-using-curl-or-irm">
Quick install using curl or irm
</h2>
<p>
The following experimental installer should work for macOS and Linux
(e.g. Debian, Ubuntu, Raspberry Pi OS)
</p>
<p>
Copy and run the following command in your shell (e.g. Terminal)
</p>
<pre><code>curl https://caltechlibrary.github.io/mkpage/installer.sh | sh</code></pre>
<p>
With Windows you can use the Powershell command.
</p>
<pre><code>irm https://caltechlibrary.github.io/mkpage/installer.ps1 | iex</code></pre>
<h2 id="installing-manually-from-github-release">
Installing manually from GitHub release
</h2>
<p>
For latest the released versions of <code>mkpage</code> go to the
project page on GitHub and click latest release
</p>
<blockquote>
<p>
https://github.com/caltechlibrary/mkpage/releases/latest
</p>
</blockquote>
<p>
You will seea list of filenames is in the form of
<code>mkpage-VERSION_NO-PLATFORM_NAME.zip</code>.
</p>
<blockquote>
<p>
VERSION_NUMBER is a <a href="http://semver.org/">symantic version
number</a> (e.g. v0.1.1)
</p>
</blockquote>
<blockquote>
<p>
PLATFROM_NAME is a description of a platform (e.g. windows-amd64,
macos-amd64).
</p>
</blockquote>
<p>
Compiled versions are available for macOS (Intel and M1/M2 processors,
macOS-x86_64, macOS-arm64), Linux (Intel processor, Linux-x86_64),
Windows (Intel processor, Windows-x86_64) and Rapsberry Pi (ARM7
processor, RaspberryPiOS-arm7).
</p>
<table>
<thead>
<tr class="header">
<th>
Platform
</th>
<th>
Zip Filename
</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>
Windows (Intel)
</td>
<td>
mkpage-VERSION_NUMBER-Windows-x86_64.zip
</td>
</tr>
<tr class="even">
<td>
Windows (ARM64)
</td>
<td>
mkpage-VERSION_NUMBER-Windows-x86_64.zip
</td>
</tr>
<tr class="odd">
<td>
macOS (Intel)
</td>
<td>
mkpage-VERSION_NUMBER-macOS-x86_64.zip
</td>
</tr>
<tr class="even">
<td>
macOS (M1/M2)
</td>
<td>
mkpage-VERSION_NUMBER-macOS-arm64.zip
</td>
</tr>
<tr class="odd">
<td>
Linux (Intel)
</td>
<td>
mkpage-VERSION_NUMBER-Linux-x86_64.zip
</td>
</tr>
<tr class="even">
<td>
Linux (ARM64)
</td>
<td>
mkpage-VERSION_NUMBER-Linux-aarch64.zip
</td>
</tr>
<tr class="odd">
<td>
Raspbery Pi
</td>
<td>
mkpage-VERSION_NUMBER-RaspberryPiOS-arm7.zip
</td>
</tr>
</tbody>
</table>
<h2 id="the-basic-recipe">
The basic recipe
</h2>
<ul>
<li>
Download the zip file matching your platform
</li>
<li>
Unzip it
</li>
<li>
Copy the contents of the “bin” folder to a folder in your shell’s path
(e.g. $HOME/bin).
</li>
<li>
Adjust you PATH if needed
</li>
<li>
test to see if it worked
</li>
</ul>
<h3 id="macos">
macOS
</h3>
<ol type="1">
<li>
Download the zip file
</li>
<li>
Unzip the zip file
</li>
<li>
Copy the executables to $HOME/bin (or a folder in your path)
</li>
<li>
Test
</li>
</ol>
<p>
Here’s an example of the commands run in the Terminal App after
downloading the zip file.
</p>
<pre class="shell"><code> cd Downloads/
unzip mkpage-*-macOS-x86_64.zip
mkdir -p $HOME/bin
cp -v bin/* $HOME/bin/
export PATH=$HOME/bin:$PATH
mkpage -version</code></pre>
<h3 id="windows-10">
Windows 10
</h3>
<ol type="1">
<li>
Download the zip file
</li>
<li>
Unzip the zip file
</li>
<li>
Copy the executables to $HOME/bin (or a folder in your path)
</li>
<li>
Test
</li>
</ol>
<p>
Here’s an example of the commands run in from the Bash shell on Windows
10 after downloading the zip file.
</p>
<pre class="shell"><code> cd Downloads/
unzip mkpage-*-Windows-x86_64.zip
mkdir -p $HOME/bin
cp -v bin/* $HOME/bin/
export PATH=$HOME/bin:$PATH
mkpage -version</code></pre>
<h3 id="linux">
Linux
</h3>
<ol type="1">
<li>
Download the zip file
</li>
<li>
Unzip the zip file
</li>
<li>
Copy the executables to <code>$HOME/bin</code> (or a folder in your
path)
</li>
<li>
Test
</li>
</ol>
<p>
Here’s an example of the commands run in from the Bash shell after
downloading the zip file.
</p>
<pre class="shell"><code> cd Downloads/
unzip mkpage-*-Linux-x86_64.zip
mkdir -p $HOME/bin
cp -v bin/* $HOME/bin/
export PATH=$HOME/bin:$PATH
mkpage -version</code></pre>
<h3 id="raspberry-pi">
Raspberry Pi
</h3>
<p>
Released version is for a Raspberry Pi 2 or later use (i.e. requires ARM
7 support).
</p>
<ol type="1">
<li>
Download the zip file
</li>
<li>
Unzip the zip file
</li>
<li>
Copy the executables to <code>$HOME/bin</code> (or a folder in your
path)
</li>
<li>
Test
</li>
</ol>
<p>
Here’s an example of the commands run in from the Bash shell after
downloading the zip file.
</p>
<pre class="shell"><code> cd Downloads/
unzip mkpage-*-RaspberryPiOS-arm7.zip
mkdir -p $HOME/bin
cp -v bin/* $HOME/bin/
export PATH=$HOME/bin:$PATH
mkpage -version</code></pre>
<h2 id="compiling-from-source">
Compiling from source
</h2>
<p>
<em>mkpage</em> is “go gettable”. Use the “go get” command to download
the dependant packages as well as <em>mkpage</em>’s source code.
</p>
<pre class="shell"><code> go get -u github.com/caltechlibrary/pkgassets/...
go get -u github.com/caltechlibrary/mkpage/...</code></pre>
<p>
Or clone the repository and then compile
</p>
<pre class="shell"><code> cd
git clone https://github.com/caltechlibrary/pkgassets src/github.com/caltechlibrary/pkgassets
cd src/github.com/caltechlibrary/pkgassets
make
make test
make install
cd
git clone https://github.com/caltechlibrary/mkpage src/github.com/caltechlibrary/mkpage
cd src/github.com/caltechlibrary/mkpage
make
make test
make install</code></pre>
</section>
<footer>
<span><h1><A href="http://caltech.edu">Caltech</a></h1></span>
<span>© 2021 <a href="https://www.library.caltech.edu/copyright">Caltech library</a></span>
<address>1200 E California Blvd, Mail Code 1-32, Pasadena, CA 91125-3200</address>
<span>Phone: <a href="tel:+1-626-395-3405">(626)395-3405</a></span>
<span><a href="mailto:library@caltech.edu">Email Us</a></span>
<a class="cl-hide" href="sitemap.xml">Site Map</a>
</footer>
</body>
</html>