-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathINSTALL.html
192 lines (187 loc) · 6.46 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
<!DOCTYPE html>
<html lang="en-US">
<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="./">README</a></li>
<li><a href="user_manual.html">User Manual</a></li>
<li><a href="LICENSE">LICENSE</a></li>
<li><a href="about.html">About</a></li>
<li><a href="INSTALL.html">Install</a></li>
<li><a href="https://github.com/rsdoiel/scripttool">GitHub</a></li>
</ul>
</nav>
<section>
<!-- <h1>INSTALL</h1> -->
<h1 id="installation">Installation</h1>
<p><em>scripttool</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/scripttool/releases/latest">releases</a></p>
<h2 id="quick-install-via-curl-or-irm">Quick install via curl or
irm</h2>
<p>This project can be installed via curl and sh for POSIX compatible
systems. Enter the following in your shell.</p>
<pre><code>curl https://rsdoiel.github.io/scripttool/installer.sh | sh</code></pre>
<p>On Windows use the following Powershell command.</p>
<pre><code>irm https://rsdoiel.github.io/scripttool/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 (Intel and M1/M2
processor, macOS-x86_64, macOS-arm64), Linux (Intel process,
Linux-x86_64), Windows (Intel processor, Windows-x86_64), Raspberry Pi
OS (arm7 32bit processor, RaspberryPiOS-arm7) and Pine64 (arm64
processor, Linux-aarch64)</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/scripttool/releases/latest</p>
</blockquote>
<table>
<thead>
<tr class="header">
<th>Platform</th>
<th>Zip Filename</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>Windows</td>
<td>scripttool-VERSION_NUMBER-Windows-x86_64.zip</td>
</tr>
<tr class="even">
<td>Mac OS (Intel)</td>
<td>scripttool-VERSION_NUMBER-macOS-x86_64.zip</td>
</tr>
<tr class="odd">
<td>Mac OS (M1,M2)</td>
<td>scripttool-VERSION_NUMBER-macOS-arm64.zip</td>
</tr>
<tr class="even">
<td>Linux/Intel</td>
<td>scripttool-VERSION_NUMBER-Linux-x86_64.zip</td>
</tr>
<tr class="odd">
<td>Raspberry Pi</td>
<td>scripttool-VERSION_NUMBER-RaspberryPiOS-arm7.zip</td>
</tr>
<tr class="even">
<td>Pine64</td>
<td>scripttool-VERSION_NUMBER-Linux-aarch64.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>(e.g. if you’re on a Windows 10 laptop/Surface with a amd64 style
CPU you’d choose the Zip file with “windows-amd64” 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</li>
</ul>
<h3 id="mac-os">Mac OS</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 scripttool-*-macOS-x86_64.zip
mkdir -p $HOME/bin
cp -v bin/* $HOME/bin/
export PATH=$HOME/bin:$PATH
scripttool -version</code></pre>
<h3 id="windows">Windows</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 scripttool-*-Windows-x86_64.zip
mkdir -p $HOME/bin
cp -v bin/* $HOME/bin/
export PATH=$HOME/bin:$PATH
scripttool -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 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 scripttool-*-Linux-x86_64.zip
mkdir -p $HOME/bin
cp -v bin/* $HOME/bin/
export PATH=$HOME/bin:$PATH
scripttool -version</code></pre>
<h3 id="raspberry-pi-os">Raspberry Pi OS</h3>
<p>Released version is for a Raspberry Pi 3 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 scripttool-*-RaspberryPiOS-arm7.zip
mkdir -p $HOME/bin
cp -v bin/* $HOME/bin/
export PATH=$HOME/bin:$PATH
scripttool -version</code></pre>
<h2 id="compiling-from-source">Compiling from source</h2>
<p><em>scripttool</em> is “go gettable”. Use the “go get” command to
download the dependent packages as well as <em>scripttool</em>’s source
code.</p>
<pre class="shell"><code> go get -u github.com/rsdoiel/scripttool/...</code></pre>
<p>Or clone the repository and then compile</p>
<pre class="shell"><code> cd
git clone https://github.com/rsdoiel/scripttool src/github.com/rsdoiel/scripttool
cd src/github.com/rsdoiel/scripttool
make
make test
make install</code></pre>
</section>
<footer>
</footer>
</body>
</html>