Skip to content

Commit

Permalink
fixing INSTALL.html on macOS
Browse files Browse the repository at this point in the history
  • Loading branch information
rsdoiel committed Aug 9, 2022
1 parent 935dca0 commit 612e96c
Showing 1 changed file with 184 additions and 0 deletions.
184 changes: 184 additions & 0 deletions INSTALL.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,184 @@
<!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="./">README</a></li>
<li><a href="user-manual.html">User Manual</a></li>
<li><a href="license.html">LICENSE</a></li>
<li><a href="about.html">About</a></li>
<li><a href="INSTALL.html">Install</a></li>
<li><a href="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/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="compiled-version">Compiled version</h2>
<p>This is generalized instructions for a release.</p>
<p>Compiled versions are available for Mac OS X (amd64 and M1 processor,
macos-amd64, macos-arm64), Linux (amd64 process, linux-amd64), Windows
(amd64 processor, windows-amd64), Rapsberry Pi (arm7 processor,
raspbian-arm7) and Pine64 (arm64 processor, linux-arm64)</p>
<p>VERSION_NUMBER is a <a href="http:https://semver.org/">symantic 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-amd64.zip</td>
</tr>
<tr class="even">
<td>Mac OS X</td>
<td>scripttool-VERSION_NUMBER-macos-amd64.zip</td>
</tr>
<tr class="odd">
<td>Mac OS X</td>
<td>scripttool-VERSION_NUMBER-macos-arm64.zip</td>
</tr>
<tr class="even">
<td>Linux/Intel</td>
<td>scripttool-VERSION_NUMBER-linux-amd64.zip</td>
</tr>
<tr class="odd">
<td>Raspbery Pi</td>
<td>scripttool-VERSION_NUMBER-raspbian-arm7.zip</td>
</tr>
<tr class="even">
<td>Pine64</td>
<td>scripttool-VERSION_NUMBER-linux-arm64.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-x">Mac OS X</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>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-amd64.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 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 scripttool-*-windows-amd64.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 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 class="shell"><code> cd Downloads/
unzip scripttool-*-linux-amd64.zip
mkdir -p $HOME/bin
cp -v bin/* $HOME/bin/
export PATH=$HOME/bin:$PATH
scripttool -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 $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-*-raspbian-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 dependant 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 repstory 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>

0 comments on commit 612e96c

Please sign in to comment.