Skip to content

Latest commit

 

History

History
177 lines (129 loc) · 4.51 KB

INSTALL.md

File metadata and controls

177 lines (129 loc) · 4.51 KB
Raw

Installation

MkPage Project is a set of command line programs run from a shell like Bash. NOTE: mkpage depends on Pandoc (>= v3).

Quick install using curl or irm

The following experimental installer should work for macOS and Linux (e.g. Debian, Ubuntu, Raspberry Pi OS)

Copy and run the following command in your shell (e.g. Terminal)

curl https://caltechlibrary.github.io/mkpage/installer.sh | sh

With Windows you can use the Powershell command.

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

Installing manually from GitHub release

For latest the released versions of mkpage go to the project page on GitHub and click latest release

https://github.com/caltechlibrary/mkpage/releases/latest

You will seea list of filenames is in the form of mkpage-VERSION_NO-PLATFORM_NAME.zip.

VERSION_NUMBER is a symantic version number (e.g. v0.1.1)

PLATFROM_NAME is a description of a platform (e.g. windows-amd64, macos-amd64).

Compiled versions are available for macOS (Intel and M1/M2 processors, macOS-x86_64, macOS-arm64), Linux (Intel processor, Linux-x86_64), Windows (Intel processor, Windows-x86_64) and Rapsberry Pi (ARM7 processor, RaspberryPiOS-arm7).

Platform Zip Filename
Windows (Intel) mkpage-VERSION_NUMBER-Windows-x86_64.zip
Windows (ARM64) mkpage-VERSION_NUMBER-Windows-x86_64.zip
macOS (Intel) mkpage-VERSION_NUMBER-macOS-x86_64.zip
macOS (M1/M2) mkpage-VERSION_NUMBER-macOS-arm64.zip
Linux (Intel) mkpage-VERSION_NUMBER-Linux-x86_64.zip
Linux (ARM64) mkpage-VERSION_NUMBER-Linux-aarch64.zip
Raspbery Pi mkpage-VERSION_NUMBER-RaspberryPiOS-arm7.zip

The basic recipe

  • Download the zip file matching your platform
  • Unzip it
  • Copy the contents of the "bin" folder to a folder in your shell's path (e.g. $HOME/bin).
  • Adjust you PATH if needed
  • test to see if it worked

macOS

  1. Download the zip file
  2. Unzip the zip file
  3. Copy the executables to $HOME/bin (or a folder in your path)
  4. Test

Here's an example of the commands run in the Terminal App after downloading the zip file.

    cd Downloads/
    unzip mkpage-*-macOS-x86_64.zip
    mkdir -p $HOME/bin
    cp -v bin/* $HOME/bin/
    export PATH=$HOME/bin:$PATH
    mkpage -version

Windows 10

  1. Download the zip file
  2. Unzip the zip file
  3. Copy the executables to $HOME/bin (or a folder in your path)
  4. Test

Here's an example of the commands run in from the Bash shell on Windows 10 after downloading the zip file.

    cd Downloads/
    unzip mkpage-*-Windows-x86_64.zip
    mkdir -p $HOME/bin
    cp -v bin/* $HOME/bin/
    export PATH=$HOME/bin:$PATH
    mkpage -version

Linux

  1. Download the zip file
  2. Unzip the zip file
  3. Copy the executables to $HOME/bin (or a folder in your path)
  4. Test

Here's an example of the commands run in from the Bash shell after downloading the zip file.

    cd Downloads/
    unzip mkpage-*-Linux-x86_64.zip
    mkdir -p $HOME/bin
    cp -v bin/* $HOME/bin/
    export PATH=$HOME/bin:$PATH
    mkpage -version

Raspberry Pi

Released version is for a Raspberry Pi 2 or later use (i.e. requires ARM 7 support).

  1. Download the zip file
  2. Unzip the zip file
  3. Copy the executables to $HOME/bin (or a folder in your path)
  4. Test

Here's an example of the commands run in from the Bash shell after downloading the zip file.

    cd Downloads/
    unzip mkpage-*-RaspberryPiOS-arm7.zip
    mkdir -p $HOME/bin
    cp -v bin/* $HOME/bin/
    export PATH=$HOME/bin:$PATH
    mkpage -version

Compiling from source

mkpage is "go gettable". Use the "go get" command to download the dependant packages as well as mkpage's source code.

    go get -u github.com/caltechlibrary/pkgassets/...
    go get -u github.com/caltechlibrary/mkpage/...

Or clone the repository and then compile

    cd
    git clone https://github.com/caltechlibrary/pkgassets src/github.com/caltechlibrary/pkgassets
    cd src/github.com/caltechlibrary/pkgassets
    make
    make test
    make install
    cd
    git clone https://github.com/caltechlibrary/mkpage src/github.com/caltechlibrary/mkpage
    cd src/github.com/caltechlibrary/mkpage
    make
    make test
    make install