I had to search for a while to find documention about the installation process.
It seems the Markdown version of the README file in commit cf99772 contains this information in lines 84–117:
|
# Download and Installation |
|
|
|
## Pre-Compiled Binaries |
|
You can download executables of `frangipanni` from the Github repository in the [Releases area.](https://github.com/birchb1024/frangipanni/releases) You will find archive files containing the binary and Lua files: |
|
|
|
``` |
|
frangipanni_darwin_amd64.zip |
|
frangipanni_freebsd_amd64.zip |
|
frangipanni_js_wasm.zip |
|
frangipanni_linux_386.tgz |
|
frangipanni_linux_amd64.tgz |
|
frangipanni_linux_arm64.tgz |
|
frangipanni_netbsd_amd64.zip |
|
frangipanni_openbsd_amd64.zip |
|
frangipanni_windows_386.zip |
|
frangipanni_windows_amd64.zip |
|
``` |
|
|
|
Download the file for your operating system and hardware, then decompress the archive in a directory. Ensure the binary file is executable, and you're ready to go. Your directory should look something like this, depending on operating system: |
|
``` |
|
. |
|
├── [-rwxrwxr-x] frangipanni_linux_arm64 |
|
├── [-rw-rw-r--] json.lua |
|
├── [-rw-rw-r--] markdown.lua |
|
└── [-rw-rw-r--] xml.lua |
|
``` |
|
|
|
I have tested `frangipanni_linux_amd64`, the others are output from the Go cross-compiler and are provided 'as-is'. Please send a Pull Request if you find an issue. |
|
|
|
## Building From Source Code |
|
|
|
If there is no pre-compiled binary or your platform, you can compile from the source. First you need [the 'Go' compiler](https://golang.org/doc/install), version 1.15.2 or greater. After cloning [the frangipanni repository](https://github.com/birchb1024/frangipanni) with git, it suffices to run `GO111MODULE=on go build` and the executable will be built as `frangipanni`. You can run the regression test suite with `test/confidence.sh`, but first install `jp` from [github.com/jmespath/jp](https://github.com/jmespath/jp). |
|
|
|
Read all about `Go` here: [golang.org](https://golang.org/) |
But the default README in master (README.org?), which is the default one rendered for the GitHub project, doesn't seem to include this information.
