INSTALL.html

<!DOCTYPE html>
<html lang="en">
<head>
    <title>Newt -- INSTALL</title>
    <link rel="stylesheet" href="https://caltechlibrary.github.io/css/site.css">
    <base href="./">
</head>
<body>
<header>
<a href="https://library.caltech.edu"><img src="https://caltechlibrary.github.io/assets/liblogo.gif" alt="Caltech Library logo"></a>
</header>
<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="INSTALL.html">INSTALL</a></li>
	<li><a href="about.html">About</a></li>
	<li><a href="search.html">Search</a></li>
	<li><a href="https://github.com/caltechlibrary/newt">GitHub</a></li>
</ul>
</nav>

<section>
<h2 id="installation">Installation</h2>
<p>Newt is an experimental set of programs for rapid application
development for libraries, archives and museums. It provides a data
router, code generator and Mustache template engine. At this time you
must install it from source code. The programs are likely broken, poorly
documented and certainly contain bugs. It’s a prototype!</p>
<h2 id="quick-install-with-curl-or-irm">Quick install with curl or
irm</h2>
<p>If you are running macOS or Linux you can install released versions
of newt with the following curl command.</p>
<pre><code>curl https://caltechlibrary.github.io/newt/installer.sh</code></pre>
<p>In Powershell on Windows you can use the following command</p>
<pre><code>irm https://caltechlibrary.github.io/newt/installer.ps1 | iex</code></pre>
<h2 id="install-from-source">Install from source</h2>
<h2 id="installation-requirements">Installation Requirements</h2>
<ul>
<li>Go &gt;= 1.22.5</li>
<li>Deno &gt;= 1.44</li>
<li>Pandoc &gt; 3.1 (to render Markdown content and some Go code)</li>
<li>Git compatible tool for retrieving the GitHub repository of
Newt</li>
<li>GNU Make &gt; 4</li>
<li>GNU grep &gt; 3</li>
<li>GNU cut &gt; 8</li>
</ul>
<h3 id="building-from-source-code">Building from source code</h3>
<ol type="1">
<li>Make sure you have the required development software installed</li>
<li>Clone the Newt GitHub repository locally</li>
<li>Use the Go tool to build, test and run the application</li>
</ol>
<h5 id="step-1">step 1</h5>
<p>Make sure you have the necessary software installed first. The list
is below. If you are building on Windows you’ll need to use the LSW to
follow along and the tools will need to be available in the WSL.
Otherwise the steps are generally similar for macOS, Windows and
Linux.</p>
<ul>
<li>Go &gt;= 1.22.5</li>
<li>Deno &gt;= 1.44</li>
<li>Pandoc &gt; 3.1 (to render Markdown content and some Go code)</li>
<li>Git cli or compatible tool for retrieving the GitHub repository of
Newt</li>
<li>GNU Make &gt; 4</li>
<li>GNU grep &gt; 3</li>
<li>GNU cut &gt; 8</li>
</ul>
<h4 id="step-2">step 2</h4>
<ol type="1">
<li>Start in your home directory</li>
<li>Clone Newt’s <a
href="https://github.com/caltechlibrary/newt">repository</a>.</li>
<li>Change into the Newt directory</li>
</ol>
<p>From the terminal application running a POSIX shell I type the
following.</p>
<pre class="shell"><code>cd
git clone \
   https://github.com/caltechlibrary/newt \
   src/github.com/caltechlibrary/newt
cd src/github.com/caltechlibrary/newt</code></pre>
<h4 id="step-3">step 3</h4>
<p>For step three tasks you have two choices. You can use the Go command
Or you can run the Make command. The latter has the advantage that it’ll
build help docuemntaiton, man pages and install the man pages in your
home directory.</p>
<p>It assumed you are still in the directory where you completed step
2.</p>
<ol type="1">
<li>Build the newt application</li>
<li>Test the newt application</li>
<li>If the tests are successful then you can install Newt tools</li>
</ol>
<p>Here’s the Go command version.</p>
<pre class="shell"><code>go build
go test
go install</code></pre>
<p>Here’s the Make version.</p>
<pre><code>make
make test
make install</code></pre>
<!--

## Precompiled binaries

You can find prep-compiled binaries for some versions of Newt. They are available at <https://github.com/caltechlibrary/newt/releases>.

The binaries are available in a Zip archive file for download. The name uses the form `newt-<VERSION_NO>-<OS_TYPE>-<CPU_TYPE>.zip`. VERSION_NO will be a semver associated with the release (e.g. "v0.0.2"), the OS_TYPE will be either "Linux" (including Raspberry Pi OS), "Windows" and "macOS". The CPU_TYPE will vary based on how the CPU type is reported on the POSIX system (e.g. what is returned by `uname -m`) or in the case of Windows either "x86_64" for Intel CPU types or "arm64" for ARM CPU (e.g. those in selected Surface tablets or Microsoft's ARM Development Kit 2023).

- macOS example
  - `newt-v0.0.2-macOS-arm64.zip` (M1, M2 CPU)
  - `newt-v0.0.2-macOS-x86_64.zip` (older Intel based Macs)
- Windows example
  - `newt-v0.0.2-Windows-x86_64.zip` (for Most Windows machines)
- Linux example (including Raspberry Pi OS)
  - `newt-v0.0.2-Linux-x86_64.zip` (Linux on Intel CPUs)
  - `newt-v0.0.2-Linux-aarch64.zip` (Linux on ARM 64)

-->
<h2 id="getting-help">Getting help</h2>
<p><strong>The Newt Project is an experiment!!</strong>. The source code
for the project is supplied “as is”. Newt is most likely broken. At a
stretch it could be considered a working prototype. You should not use
it for production systems. However if you’d like to ask a question or
have something you’d like to contribute please feel free to file a
GitHub issue, see <a
href="https://github.com/caltechlibrary/newt/issues"
class="uri">https://github.com/caltechlibrary/newt/issues</a>. Just keep
in mind it remains an <strong>experiment</strong> as of February
2024.</p>
</section>

<footer>
<span><h1><A href="http://caltech.edu">Caltech</a></h1></span>
<span>&copy; 2024 <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>