-
Notifications
You must be signed in to change notification settings - Fork 2
/
INSTALL.html
69 lines (64 loc) · 2.42 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
<!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="https://github.com/rsdoiel/osf">GitHub</a></li>
</ul>
</nav>
<section>
<!-- <h1>INSTALL</h1> -->
<h2 id="installation">Installation</h2>
<p>This project is experimental. Get the latest release from <a
href="https://github.com/rsdoiel/osf/releases/">GitHub</a>.</p>
<h2 id="quick-install-with-curl">Quick install with curl</h2>
<p>If you are using macOS or Linux you maybe able to install osf using
the following curl command.</p>
<pre class="shell"><code>curl https://rsdoiel.github.io/osf/installer.sh | sh</code></pre>
<h2 id="install-from-source">Install from source</h2>
<h2 id="requirements">Requirements</h2>
<ul>
<li>Golang >= 1.20</li>
<li>Pandoc >= 3</li>
<li>GNU Make</li>
<li>Git</li>
</ul>
<h2 id="steps">Steps</h2>
<ol type="1">
<li>Clone the Git repository for the project</li>
<li>change directory into the cloned project</li>
<li>Run <code>make</code>, <code>make test</code> and
<code>make install</code></li>
</ol>
<p>Here’s what that looks like for me.</p>
<pre><code>git clone https://github.com/rsdoiel/osf src/github.com/rsdoiel/osf
cd src/github.com/rsdoiel/osf
make
make test
make install</code></pre>
<p>By default it will install the programs in <code>$HOME/bin</code>.
<code>$HOME/bin</code> needs to be included in your <code>PATH</code>.
E.g.</p>
<pre><code>export PATH="$HOME/bin:$PATH"</code></pre>
<p>Can be added to your <code>.profile</code>, <code>.bashrc</code> or
<code>.zshrc</code> file depending on your system’s shell.</p>
</section>
<footer>
</footer>
</body>
</html>