This repository has been archived by the owner on Jun 27, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 4
/
install.html
206 lines (166 loc) · 5.48 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
<!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="https://github.com/caltechlibrary/mkpage">Github</a></li>
</ul>
</nav>
<section>
<h1>Installation</h1>
<p><em>mkpage</em> is a set of command line programs run from a shell like Bash.</p>
<p>For all the released version go to the project page on Github and click latest release</p>
<blockquote>
<p><a href="https://github.com/caltechlibrary/mkpage/releases/latest">https://github.com/caltechlibrary/mkpage/releases/latest</a></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.2)</p>
<p>PLATFROM_NAME is a description of a platform (e.g. windows-amd64, macosx-amd64).</p>
</blockquote>
<p>Compiled versions are available for Mac OS X (amd64 processor, macosx-amd64),
Linux (amd64 processor, linux-amd64), Windows (amd64 processor, windows-amd64)
and Rapsberry Pi (ARM7 processor, raspbian-arm7).</p>
<table>
<thead>
<tr>
<th>Platform</th>
<th>Zip Filename</th>
</tr>
</thead>
<tbody>
<tr>
<td>Windows</td>
<td>mkpage-VERSION_NUMBER-windows-amd64.zip</td>
</tr>
<tr>
<td>Mac OS X</td>
<td>mkpage-VERSION_NUMBER-macosx-amd64.zip</td>
</tr>
<tr>
<td>Linux/Intel</td>
<td>mkpage-VERSION_NUMBER-linux-amd64.zip</td>
</tr>
<tr>
<td>Raspbery Pi</td>
<td>mkpage-VERSION_NUMBER-raspbian-arm7.zip</td>
</tr>
</tbody>
</table>
<h2>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>Mac OS X</h3>
<ol>
<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><code class="language-shell"> cd Downloads/
unzip mkpage-*-macosx-amd64.zip
mkdir -p $HOME/bin
cp -v bin/* $HOME/bin/
export PATH=$HOME/bin:$PATH
mkpage -version
</code></pre>
<h3>Windows</h3>
<ol>
<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><code class="language-shell"> cd Downloads/
unzip mkpage-*-windows-amd64.zip
mkdir -p $HOME/bin
cp -v bin/* $HOME/bin/
export PATH=$HOME/bin:$PATH
mkpage -version
</code></pre>
<h3>Linux</h3>
<ol>
<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 after
downloading the zip file.</p>
<pre><code class="language-shell"> cd Downloads/
unzip mkpage-*-linux-amd64.zip
mkdir -p $HOME/bin
cp -v bin/* $HOME/bin/
export PATH=$HOME/bin:$PATH
mkpage -version
</code></pre>
<h3>Raspberry Pi</h3>
<p>Released version is for a Raspberry Pi 2 or later use (i.e. requires ARM 7 support).</p>
<ol>
<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 after
downloading the zip file.</p>
<pre><code class="language-shell"> cd Downloads/
unzip mkpage-*-raspbian-arm7.zip
mkdir -p $HOME/bin
cp -v bin/* $HOME/bin/
export PATH=$HOME/bin:$PATH
mkpage -version
</code></pre>
<h2>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><code class="language-shell"> go get -u github.com/caltechlibrary/pkgassets/...
go get -u github.com/caltechlibrary/mkpage/...
</code></pre>
<p>Or clone the repstory and then compile</p>
<pre><code class="language-shell"> 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>© 2020 <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>