-
Notifications
You must be signed in to change notification settings - Fork 1
/
INSTALL.html
81 lines (79 loc) · 3.28 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
<!DOCTYPE html>
<html>
<head>
<title>Institutional Repository Data Management</title>
<link href='https://fonts.googleapis.com/css?family=Open+Sans' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="https://caltechlibrary.github.io/css/site.css">
</head>
<body>
<header>
<a href="http://library.caltech.edu" title="link to Caltech Library Homepage"><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="index.html">README</a></li>
<li><a href="LICENSE">LICENSE</a></li>
<li><a href="INSTALL.html">INSTALL</a></li>
<li><a href="user_manual.html">User Manual</a></li>
<li><a href="search.html">Search Docs</a></li>
<li><a href="about.html">About</a></li>
<li><a href="https://github.com/caltechlibrary/irdmtools">GitHub</a></li>
</ul>
</nav>
<section>
<h1 id="install">INSTALL</h1>
<p>irdmtools is an <strong>experimental</strong> Go package and command
line tools for working with institutional repositories (e.g. Invenio
RDM). It is distributed in source code and in binary form for macOS
(Intel and M1), Linux (Intel and ARM 64), Raspberry Pi OS.</p>
<p>To test the latest version you need the required development
environment and follow the steps listed below in “Compiling from
Source”.</p>
<h2 id="quick-install-using-curl-or-irm">Quick install using curl or
irm</h2>
<p>The following experimental installer should get the latest stable
release for macOS and Linux (e.g. Debian, Ubuntu, Raspberry Pi OS).</p>
<p>Copy and run the following command in your shell (e.g. Terminal)</p>
<pre><code>curl https://caltechlibrary.github.io/irdmtools/installer.sh | sh</code></pre>
<p>For Windows you can use a Powershell script with the following
command.</p>
<pre><code>irm https://caltechlibrary.github.io/irdmtools/installer.ps1 | iex</code></pre>
<p>If you want to install a specific version you can download the
installer scripts. then pass the version on the command line. As an
example to install version v0.0.83 specifically you’d type the following
two command into your shell session.</p>
<pre class="shell"><code>curl https://caltechlibrary.github.io/irdmtools/installer.sh
sh installer.sh 0.0.83</code></pre>
<h2 id="requirements">Requirements</h2>
<p>This may change in the future.</p>
<ul>
<li>Git to clone the repository from GitHub</li>
<li><a href="https://golang.org">Golang</a> 1.20.4 or better</li>
<li>GNU Make</li>
<li>Pandoc 3 or better (to build documentation)</li>
<li>Bash</li>
<li>grep</li>
</ul>
<h2 id="compiling-from-source">Compiling from Source</h2>
<ol type="1">
<li>clone the repository</li>
<li>change into the cloned directory</li>
<li>run “make”, “make test” and “make install”</li>
</ol>
<p>Here’s the steps I take to build and test on my macOS box or Linux
box.</p>
<pre><code>git clone [email protected]:caltechlibrary/irdmtools.git
cd irdmtools
make
make test
make install</code></pre>
</section>
<footer>
<span>© 2023 <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><a href="mailto:[email protected]">Email Us</a></span>
<span>Phone: <a href="tel:+1-626-395-3405">(626)395-3405</a></span>
</footer>
</body>
</html>