Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README.md (and included Installation docs) missing from master branch #22

Open
j13k opened this issue Jul 19, 2023 · 0 comments
Open

README.md (and included Installation docs) missing from master branch #22

j13k opened this issue Jul 19, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@j13k
Copy link

j13k commented Jul 19, 2023

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:

frangipanni/README.md

Lines 84 to 117 in cf99772

# 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.

@birchb1024 birchb1024 self-assigned this Nov 3, 2023
@birchb1024 birchb1024 added the documentation Improvements or additions to documentation label Nov 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants