Skip to content

Commit

Permalink
prep v0.0.8 release
Browse files Browse the repository at this point in the history
  • Loading branch information
@rsdoiel
rsdoiel committed Dec 8, 2023
1 parent 1f47552 commit 235c2b5
Show file tree
Hide file tree
Showing 57 changed files with 3,046 additions and 37 deletions.
2 changes: 1 addition & 1 deletion CITATION.cff
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ authors:


repository-code: "git+https://github.com/rsdoiel/skimmer"
version: 0.0.8-dev
version: 0.0.8
license-url: "https://spdx.org/licenses/MIT"

263 changes: 263 additions & 0 deletions INSTALL.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,263 @@
<!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">Quick install with curl</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>
<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 &gt;= 2</li>
<li>GNU Make &gt;= 3.8</li>
<li>SQLite3 &gt; 3.4</li>
<li>Pandoc &gt; 3</li>
<li>Go &gt;= 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>
4 changes: 2 additions & 2 deletions Makefile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ RELEASE_DATE=$(shell date +'%Y-%m-%d')

RELEASE_HASH=$(shell git log --pretty=format:'%h' -n 1)

PROGRAMS = skimmer skim2md # $(shell ls -1 cmd)
PROGRAMS = skimmer skim2md html2skim # $(shell ls -1 cmd)

MAN_PAGES = skimmer.1 skim2md.1 # $(shell ls -1 *.1.md | sed -E 's/\.1.md/.1/g')
MAN_PAGES = skimmer.1 skim2md.1 html2skim.1 # $(shell ls -1 *.1.md | sed -E 's/\.1.md/.1/g')

HTML_PAGES = $(shell find . -type f | grep -E '\.html')

Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ To compile from source you need to have git, make, Pandoc, SQLite3 and Go.
- Make >= 3.8 (GNU Make)
- Pandoc > 3
- SQLite3 > 3.4
- Go >= 1.21.1
- Go >= 1.21.4

### Steps to compile and install

Expand Down
Loading

0 comments on commit 235c2b5

Please sign in to comment.