Skip to content

Commit

Permalink
Quick Save
Browse files Browse the repository at this point in the history
  • Loading branch information
R. S. Doiel committed Jul 9, 2024
1 parent 3d8dd32 commit 40efc05
Show file tree
Hide file tree
Showing 25 changed files with 142 additions and 31 deletions.
9 changes: 5 additions & 4 deletions INSTALL.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,15 @@ <h1 id="install">INSTALL</h1>
<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">Quick install using curl</h2>
<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>NOTE: Windows 11 support is via Window’s Sub-System for Linux (aka
WSL). If you have that available then you can use the installer example
above.</p>
<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>
<h2 id="requirements">Requirements</h2>
<p>This may change in the future.</p>
<ul>
Expand Down
10 changes: 7 additions & 3 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ irdmtools is an **experimental** Go package and command line tools for working w

To test the latest version you need the required development environment and follow the steps listed below in "Compiling from Source".

Quick install using curl
------------------------
Quick install using curl or irm
-------------------------------

The following experimental installer should get the latest stable release for macOS and Linux (e.g. Debian, Ubuntu, Raspberry Pi OS).

Expand All @@ -17,7 +17,11 @@ Copy and run the following command in your shell (e.g. Terminal)
curl https://caltechlibrary.github.io/irdmtools/installer.sh | sh
~~~

NOTE: Windows 11 support is via Window's Sub-System for Linux (aka WSL). If you have that available then you can use the installer example above.
For Windows you can use a Powershell script with the following command.

~~~
irm https://caltechlibrary.github.io/irdmtools/installer.ps1 | iex
~~~


Requirements
Expand Down
9 changes: 7 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ ifeq ($(OS), Windows)
EXT = .exe
endif

build: version.go $(PROGRAMS) man CITATION.cff about.md installer.sh
build: version.go $(PROGRAMS) man CITATION.cff about.md installer.sh installer.ps1

version.go: .FORCE
@echo '' | pandoc --from t2t --to plain \
Expand Down Expand Up @@ -71,10 +71,15 @@ about.md: codemeta.json $(PROGRAMS)
@if [ -f _codemeta.json ]; then rm _codemeta.json; fi

installer.sh: .FORCE
@echo '' | pandoc --metadata title="Installer" --metadata git_org_or_person="$(GIT_GROUP)" --metadata-file codemeta.json --template codemeta-installer.tmpl >installer.sh
@echo '' | pandoc --metadata title="Installer" --metadata git_org_or_person="$(GIT_GROUP)" --metadata-file codemeta.json --template codemeta-bash-installer.tmpl >installer.sh
@chmod 775 installer.sh
@git add -f installer.sh

installer.ps1: .FORCE
@echo '' | pandoc --metadata title="Installer" --metadata git_org_or_person="$(GIT_GROUP)" --metadata-file codemeta.json --template codemeta-ps1-installer.tmpl >installer.ps1
@chmod 775 installer.ps1
@git add -f installer.ps1


test: $(PACKAGE)
#go test -timeout 120h
Expand Down
2 changes: 1 addition & 1 deletion about.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

<section>
<h1 id="about-this-software">About this software</h1>
<h2 id="irdmtools-0.0.83">irdmtools 0.0.83</h2>
<h2 id="irdmtools-0.0.84-dev">irdmtools 0.0.84-dev</h2>
<h3 id="authors">Authors</h3>
<ul>
<li>R. S. Doiel</li>
Expand Down
File renamed without changes.
48 changes: 48 additions & 0 deletions codemeta-ps1-installer.tmpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
#!/usr/bin/env pwsh
# Generated with codemeta-ps1-installer.tmpl, see https://github.com/caltechlibrary/codemeta-pandoc-examples

#
# Set the package name and version to install
#
$$PACKAGE = "$name$"
$$VERSION = "$version$"
$$GIT_GROUP = "$git_org_or_person$"
$$RELEASE = "https://github.com/$${GIT_GROUP}/$${PACKAGE}/releases/tag/v$${VERSION}"
$$SYSTEM_TYPE = Get-ComputerInfo -Property CsSystemType
if ($$SYSTEM_TYPE.CsSystemType.Contains("ARM64")) {
$$MACHINE = "arm64"
} else {
$$MACHINE = "x86_64"
}

# FIGURE OUT Install directory
$$BIN_DIR = "$${Home}\bin"
Write-Output "$${PACKAGE} will be installed in $${BIN_DIR}"

#
# Figure out what the zip file is named
#
$$ZIPFILE = "$${PACKAGE}-v$${VERSION}-Windows-$${MACHINE}.zip"

#
# Check to see if this zip file has been downloaded.
#
$$DOWNLOAD_URL = "https://github.com/$${GIT_GROUP}/$${PACKAGE}/releases/download/v$${VERSION}/$${ZIPFILE}"

if (!(Test-Path $$BIN_DIR)) {
New-Item $$BIN_DIR -ItemType Directory | Out-Null
}
curl.exe -Lo "$${ZIPFILE}" "$${DOWNLOAD_URL}"

tar.exe xf "$${ZIPFILE}" -C "$${Home}"

Remove-Item $$ZIPFILE

$$User = [System.EnvironmentVariableTarget]::User
$$Path = [System.Environment]::GetEnvironmentVariable('Path', $$User)
if (!(";$${Path};".ToLower() -like "*;$${BIN_DIR};*".ToLower())) {
[System.Environment]::SetEnvironmentVariable('Path', "$${Path};$${BIN_DIR}", $$User)
$$Env:Path += ";$${BIN_DIR}"
}

Write-Output "$${PACKAGE} was installed successfully to $${BIN_DIR}"
4 changes: 2 additions & 2 deletions doi2rdm.1.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
%doi2rdm(1) irdmtools user manual | version 0.0.84-dev 7b6afcc2
%doi2rdm(1) irdmtools user manual | version 0.0.84-dev 3d8dd325
% R. S. Doiel and Tom Morrell
% 2024-06-10
% 2024-07-09

# NAME

Expand Down
4 changes: 2 additions & 2 deletions ep3ds2citations.1.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
%ep3ds2citations(1) irdmtools user manual | version 0.0.84-dev 7b6afcc2
%ep3ds2citations(1) irdmtools user manual | version 0.0.84-dev 3d8dd325
% R. S. Doiel and Tom Morrell
% 2024-06-10
% 2024-07-09

# NAME

Expand Down
5 changes: 5 additions & 0 deletions ep3util.1.html
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,11 @@ <h1 id="harvest_options">HARVEST_OPTIONS</h1>
<dd>
Harvest records modified between start and end dates.
</dd>
<dt>-as-citations</dt>
<dd>
This harvests the record into a minimal citation form similar to
citeproc
</dd>
</dl>
<h1 id="action_parameters">ACTION_PARAMETERS</h1>
<p>Action parameters are the specific optional or required parameters
Expand Down
4 changes: 2 additions & 2 deletions ep3util.1.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
%ep3util(1) irdmtools user manual | version 0.0.84-dev 7b6afcc2
%ep3util(1) irdmtools user manual | version 0.0.84-dev 3d8dd325
% R. S. Doiel and Tom Morrell
% 2024-06-10
% 2024-07-09

# NAME

Expand Down
4 changes: 2 additions & 2 deletions eprint2rdm.1.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
%eprint2rdm(1) irdmtools user manual | version 0.0.84-dev 7b6afcc2
%eprint2rdm(1) irdmtools user manual | version 0.0.84-dev 3d8dd325
% R. S. Doiel and Tom Morrell
% 2024-06-10
% 2024-07-09

# NAME

Expand Down
4 changes: 2 additions & 2 deletions eprintrest.1.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
%eprintrest(1) irdmtools user manual | version 0.0.84-dev 7b6afcc2
%eprintrest(1) irdmtools user manual | version 0.0.84-dev 3d8dd325
% R. S. Doiel and Tom Morrell
% 2024-06-10
% 2024-07-09

# NAME

Expand Down
48 changes: 48 additions & 0 deletions installer.ps1
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
#!/usr/bin/env pwsh
# Generated with codemeta-ps1-installer.tmpl, see https://github.com/caltechlibrary/codemeta-pandoc-examples

#
# Set the package name and version to install
#
$PACKAGE = "irdmtools"
$VERSION = "0.0.84-dev"
$GIT_GROUP = "caltechlibrary"
$RELEASE = "https://github.com/${GIT_GROUP}/${PACKAGE}/releases/tag/v${VERSION}"
$SYSTEM_TYPE = Get-ComputerInfo -Property CsSystemType
if ($SYSTEM_TYPE.CsSystemType.Contains("ARM64")) {
$MACHINE = "arm64"
} else {
$MACHINE = "x86_64"
}

# FIGURE OUT Install directory
$BIN_DIR = "${Home}\bin"
Write-Output "${PACKAGE} will be installed in ${BIN_DIR}"

#
# Figure out what the zip file is named
#
$ZIPFILE = "${PACKAGE}-v${VERSION}-Windows-${MACHINE}.zip"

#
# Check to see if this zip file has been downloaded.
#
$DOWNLOAD_URL = "https://github.com/${GIT_GROUP}/${PACKAGE}/releases/download/v${VERSION}/${ZIPFILE}"

if (!(Test-Path $BIN_DIR)) {
New-Item $BIN_DIR -ItemType Directory | Out-Null
}
curl.exe -Lo "${ZIPFILE}" "${DOWNLOAD_URL}"

tar.exe xf "${ZIPFILE}" -C "${Home}"

Remove-Item $ZIPFILE

$User = [System.EnvironmentVariableTarget]::User
$Path = [System.Environment]::GetEnvironmentVariable('Path', $User)
if (!(";${Path};".ToLower() -like "*;${BIN_DIR};*".ToLower())) {
[System.Environment]::SetEnvironmentVariable('Path', "${Path};${BIN_DIR}", $User)
$Env:Path += ";${BIN_DIR}"
}

Write-Output "${PACKAGE} was installed successfully to ${BIN_DIR}"
Binary file added pagefind/fragment/unknown_25a443c.pf_fragment
Binary file not shown.
Binary file added pagefind/fragment/unknown_7e9fe31.pf_fragment
Binary file not shown.
Binary file added pagefind/fragment/unknown_7fa327d.pf_fragment
Binary file not shown.
Binary file added pagefind/fragment/unknown_c988bd6.pf_fragment
Binary file not shown.
Binary file added pagefind/index/unknown_c96490b.pf_index
Binary file not shown.
2 changes: 1 addition & 1 deletion pagefind/pagefind-entry.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"version":"1.1.0","languages":{"unknown":{"hash":"unknown_cfe43c953ae8668","wasm":null,"page_count":22}}}
{"version":"1.1.0","languages":{"unknown":{"hash":"unknown_cd8e22b74a2a0ce","wasm":null,"page_count":23}}}
Binary file added pagefind/pagefind.unknown_cd8e22b74a2a0ce.pf_meta
Binary file not shown.
4 changes: 2 additions & 2 deletions people2vocabulary.1.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
%people2vocabulary(1) irdmtools user manual | version 0.0.84-dev 7b6afcc2
%people2vocabulary(1) irdmtools user manual | version 0.0.84-dev 3d8dd325
% R. S. Doiel
% 2024-06-10
% 2024-07-09

# NAME

Expand Down
4 changes: 2 additions & 2 deletions rdm2eprint.1.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
%rdm2eprint(1) irdmtools user manual | version 0.0.84-dev 7b6afcc2
%rdm2eprint(1) irdmtools user manual | version 0.0.84-dev 3d8dd325
% R. S. Doiel and Tom Morrell
% 2024-06-10
% 2024-07-09

# NAME

Expand Down
4 changes: 2 additions & 2 deletions rdmds2citations.1.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
%rdmds2citations(1) irdmtools user manual | version 0.0.84-dev 7b6afcc2
%rdmds2citations(1) irdmtools user manual | version 0.0.84-dev 3d8dd325
% R. S. Doiel and Tom Morrell
% 2024-06-10
% 2024-07-09

# NAME

Expand Down
4 changes: 2 additions & 2 deletions rdmutil.1.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
%rdmutil(1) irdmtools user manual | version 0.0.84-dev 7b6afcc2
%rdmutil(1) irdmtools user manual | version 0.0.84-dev 3d8dd325
% R. S. Doiel and Tom Morrell
% 2024-06-10
% 2024-07-09

# NAME

Expand Down
4 changes: 2 additions & 2 deletions version.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ const (
Version = "0.0.84-dev"

// ReleaseDate, the date version.go was generated
ReleaseDate = "2024-06-10"
ReleaseDate = "2024-07-09"

// ReleaseHash, the Git hash when version.go was generated
ReleaseHash = "7b6afcc2"
ReleaseHash = "3d8dd325"

LicenseText = `
Redistribution and use in source and binary forms, with or without
Expand Down

0 comments on commit 40efc05

Please sign in to comment.