aniani/amfora
1
0
Fork 0
mirror of https://github.com/makew0rld/amfora.git synced 2024-12-04 14:46:29 -05:00
Code

📝 Add brew HEAD install to readme

Browse Source
This commit is contained in:
makeworld 2020-09-20 17:33:45 -04:00
parent b7a64ace17
commit 80b8228683
1 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -61,22 +61,35 @@ brew upgrade amfora
```
### From Source
This section is for programmers who want to install from source. Make sure you're using Go 1.13 at least, as earlier versions will fail to build.
This section is for advanced users who want to install the latest (possibly unstable) version of Amfora.
The recommended way of installing Amfora fom source is using the Makefile.
**Requirements:**
- Go 1.13 or later
- GNU Make
On Windows, you need install make, which can be done with [Chocolatey](https://chocolatey.org/install): `choco install make`. Please note the Makefile does not intend to support Windows, and so there may be issues.
Please note the Makefile does not intend to support Windows, and so there may be issues.
```shell
git clone https://github.com/makeworld-the-better-one/amfora
cd amfora
# git checkout v1.2.3 # Optionally pin to a specific version instead of the latest commit
make
make # Might be gmake on macOS
sudo make install # If you want to install the binary for all users
```
Because you installed with the Makefile, running `amfora -v` will tell you exactly what commit the binary was built from.
MacOS users can also use [Homebrew](https://brew.sh/) to install the latest commit of Amfora:
```
brew tap makeworld-the-better-one/tap
brew install --HEAD amfora
```
You can update it with:
```
brew upgrade --fetch-HEAD amfora
```
## Usage
Just call `amfora` or `amfora <url>` on the terminal. On Windows it might be `amfora.exe` instead.