-
Notifications
You must be signed in to change notification settings - Fork 0
/
INSTALL.html
266 lines (261 loc) · 9.23 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
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="language" content="EN">
<title>R. S. Doiel, Software Engineer/Analyst - INSTALL</title>
<link rel="stylesheet" type="text/css" href="/printfonts/print.css" media="print" />
<link rel="stylesheet" type="text/css" href="/webfonts/fonts.css" media="screen" />
<link rel="stylesheet" type="text/css" href="/css/site.css" media="screen" />
<link title="RSS feed for rsdoiel's blog" rel="alternate" type="application/rss+xml" href="https://rsdoiel.github.io/rss.xml" />
<link title="markdown source for page" rel="alternative" type="application/markdown" href="INSTALL.md">
</head>
<body>
<nav>
<ul>
<li><a href="/">Home</a></li>
<li><a href="index.html">README</a></li>
<li><a href="user-manual.html">User Manual</a></li>
<li><a href="LICENSE">LICENSE</a></li>
<li><a href="INSTALL.html">Install</a></li>
<li><a href="search.html">Project Search</a></li>
<li><a href="ideas.html">Someday, Maybe</a></li>
<li><a href="https://github.com/rsdoiel/stngo">GitHub</a></li>
<li><a href="about.html">About</a></li>
</ul>
</nav>
<section>
<!-- <h1>INSTALL</h1> -->
<h1 id="installation">Installation</h1>
<p><em>skimmer</em> is a command line program run from a shell like
Bash. You can find compiled version in the <a
href="https://github.com/rsdoiel/skimmer/releases/latest">releases</a></p>
<h2 id="quick-install-with-curl-or-irm">Quick install with curl or
irm</h2>
<p>The following curl command can be used to run the installer on most
POSIX systems. Programs are installed into <code>$HOME/bin</code>.
<code>$HOME/bin</code> will need to be in your path. From a shell (or
terminal session) run the following.</p>
<pre><code>curl https://rsdoiel.github.io/skimmer/installer.sh | sh</code></pre>
<p>On Windows you’d use the following command</p>
<pre><code>irm https://rsdoiel.github.io/skimmer/installer.ps1 | iex</code></pre>
<h2 id="compiled-version">Compiled version</h2>
<p>This is generalized instructions for a release.</p>
<p>Compiled versions are available for Mac OS X (Intel and M1
processors, macOS-x86_64, macOS-arm64), Linux Intel and ARM (x86_64,
aarch64, armv7l ), Windows 11 Intel/ARM (x86_64, aarch64), Raspberry Pi
(Linux and arml7).</p>
<p>VERSION_NUMBER is a <a href="http://semver.org/">semantic version
number</a> (e.g. v0.1.2)</p>
<p>For all the released version go to the project page on GitHub and
click latest release</p>
<blockquote>
<p>https://github.com/rsdoiel/skimmer/releases/latest</p>
</blockquote>
<table>
<thead>
<tr class="header">
<th>Platform</th>
<th>Zip Filename</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>Windows 11</td>
<td>skimmer-VERSION_NUMBER-Windows-x86_64.zip</td>
</tr>
<tr class="even">
<td>Windows 11</td>
<td>skimmer-VERSION_NUMBER-Windows-arm64.zip</td>
</tr>
<tr class="odd">
<td>Mac OS X</td>
<td>skimmer-VERSION_NUMBER-macOS-x86_64.zip</td>
</tr>
<tr class="even">
<td>Mac OS X</td>
<td>skimmer-VERSION_NUMBER-macOS-arm64.zip</td>
</tr>
<tr class="odd">
<td>Linux/Intel</td>
<td>skimmer-VERSION_NUMBER-Linux-x86_64.zip</td>
</tr>
<tr class="even">
<td>Linux/ARM 64</td>
<td>skimmer-VERSION_NUMBER-Linux-aarch64.zip</td>
</tr>
<tr class="odd">
<td>Linux/ARM 32</td>
<td>skimmer-VERSION_NUMBER-Linux-armv7l.zip</td>
</tr>
</tbody>
</table>
<h2 id="the-basic-recipe">The basic recipe</h2>
<ul>
<li>Find the Zip file listed matching the architecture you’re running
and download it
<ul>
<li>Example: if you’re on a Windows 11 desktop or laptop using an Intel
style CPU and you would look for the name with “Windows-x86-64”</li>
<li>Example: if you’re on a Windows 11 Surface tablet with a arm64 CPU
or the “Windows ARM Developer Kit” you’d choose the Zip file with
“Windows-arm64” in the name</li>
</ul></li>
<li>Download the zip file and unzip the file.<br />
</li>
<li>Copy the contents of the folder named “bin” to a folder that is in
your path
<ul>
<li>(e.g. “$HOME/bin” is common).</li>
</ul></li>
<li>Adjust your PATH if needed
<ul>
<li>(e.g. export PATH=“<span
class="math inline"><em>H</em><em>O</em><em>M</em><em>E</em>/<em>b</em><em>i</em><em>n</em>:</span>PATH”)</li>
</ul></li>
<li>Test by displaying the version string</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 executable to $HOME/bin (or a folder in your path)</li>
<li>Make sure the new location in in our 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 skimmer-*-macOS-x86_64.zip
mkdir -p $HOME/bin
cp -v bin/* $HOME/bin/
export PATH=$HOME/bin:$PATH
skimmer -version</code></pre>
<h3 id="windows-11-intel">Windows 11 Intel</h3>
<ol type="1">
<li>Download the zip file</li>
<li>Unzip the zip file</li>
<li>Copy the executable 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 skimmer-*-Windows-x86_64.zip
.\bin\skimmer.exe -version</code></pre>
<h3 id="windows-11-arm">Windows 11 ARM</h3>
<ol type="1">
<li>Download the zip file</li>
<li>Unzip the zip file</li>
<li>Copy the executable 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 skimmer-*-Windows-arm64.zip
.\bin\skimmer.exe -version</code></pre>
<h3 id="linux-intel">Linux Intel</h3>
<ol type="1">
<li>Download the zip file</li>
<li>Unzip the zip file</li>
<li>Copy the executable 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 class="shell"><code> cd Downloads/
unzip skimmer-*-Linux-x86_64.zip
mkdir -p $HOME/bin
cp -v bin/skimmer $HOME/bin/
export PATH=$HOME/bin:$PATH
skimmer -version</code></pre>
<h3 id="linux-arm64">Linux ARM64</h3>
<ol type="1">
<li>Download the zip file</li>
<li>Unzip the zip file</li>
<li>Copy the executable 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 class="shell"><code> cd Downloads/
unzip skimmer-*-Linux-aarch64.zip
mkdir -p $HOME/bin
cp -v bin/skimmer $HOME/bin/
export PATH=$HOME/bin:$PATH
skimmer -version</code></pre>
<h3 id="raspberry-pi-os">Raspberry Pi OS</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 executable 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 class="shell"><code> cd Downloads/
unzip skimmer-*-Linux-armv7l.zip
mkdir -p $HOME/bin
cp -v bin/skimmer $HOME/bin/
export PATH=$HOME/bin:$PATH
skimmer -version</code></pre>
<h3 id="windows-11">Windows 11</h3>
<p>The general steps</p>
<ol type="1">
<li>Download the zip file into your “Downloads” folder with your web
browser</li>
<li>Setup your path to where you will install the <code>.exe</code>
file</li>
<li>Unzip the zip file</li>
<li>Copy the executable to the “bin” directory in to someplace where
Windows cmd shell file find it</li>
<li>Test</li>
</ol>
<pre class="shell"><code> mkdir %userprofile%\bin
set PATH=%PATH%;%userprofile$\bin
powershell Expand-Archive Downloads\dataset-*-Windows-*.zip Dataset
copy Dataset\bin\*.exe %userprofile%\bin\
skimmer -version</code></pre>
<h2 id="compiling-from-source">Compiling from source</h2>
<p><em>skimmer</em> is “go get-able”. Use the “go get” command to
download the dependent packages as well as <em>skimmer</em>’s source
code.</p>
<pre class="shell"><code> go get -u github.com/rsdoiel/skimmer/...</code></pre>
<h3 id="requirements-for-compiling-using-gnu-make">Requirements for
compiling using GNU Make</h3>
<ol type="1">
<li>Git >= 2</li>
<li>GNU Make >= 3.8</li>
<li>SQLite3 > 3.4</li>
<li>Pandoc > 3</li>
<li>Go >= 1.21.1</li>
</ol>
<h3 id="compiling-on-a-posix-system">Compiling on a POSIX system</h3>
<p>If you have all the required software (e.g. Git, GNU Make, Pandoc,
SQLite3, Go) you can clone the repository and then compile in the
traditional POSIX manner.</p>
<pre class="shell"><code> cd
git clone https://github.com/rsdoiel/skimmer src/github.com/rsdoiel/skimmer
cd src/github.com/rsdoiel/skimmer
make
make test
make install</code></pre>
<h4 id="compiling-on-a-windows-machine">Compiling on a Windows
machine</h4>
<p>For Windows you need to have Go installed. I am assuming you will NOT
be regenerating versions.go using Pandoc.</p>
<p>On a Windows box in the command shell these are the steps I would
take</p>
<pre class="shell"><code> cd %userprofile%
set PATH=%PATH%;%userprofile%\bin
go build cmd\skimmer\skimmer.go
move skimmer.exe %userprofile%\bin\
skimmer -version</code></pre>
</section>
<footer>
</footer>
</body>
</html>