From 81673ef366bb2530cf9a079e38da35fd8763754c Mon Sep 17 00:00:00 2001 From: Liam Galvin Date: Thu, 6 Dec 2018 13:31:34 +0000 Subject: [PATCH] readme updartes --- README.md | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 968914f..52cadab 100644 --- a/README.md +++ b/README.md @@ -30,31 +30,40 @@ Ensure you have your latest graphics card drivers installed before use. - Built-in patched fonts for powerline - Retina display support -## Quick Start +## Installation -### Installation +### MacOS -#### Prebuilt Binaries +``` +brew tap liamg/aminal +brew install aminal +``` + +### Windows + +A Windows version of Aminal is expected in the next 1-2 months. + +### Prebuilt Binaries Prebuilt binaries are available for Linux and OSX on the [releases](https://github.com/liamg/aminal/releases) page. -Download the binary and `sudo cp aminal-* /usr/local/bin/aminal`. +Download the binary and `sudo cp aminal-* /usr/local/bin/aminal && chmod +x /usr/local/bin/aminal`. -#### Install with Go +### Install with Go ``` go get -u github.com/liamg/aminal ``` -### Build +## Build -#### Dependencies +### Dependencies - On macOS, you need Xcode or Command Line Tools for Xcode (`xcode-select --install`) for required headers and libraries. - On Ubuntu/Debian-like Linux distributions, you need `libgl1-mesa-dev xorg-dev`. - On CentOS/Fedora-like Linux distributions, you need `libX11-devel libXcursor-devel libXrandr-devel libXinerama-devel mesa-libGL-devel libXi-devel`. -#### Building Locally +### Building Locally There are various make targets available, the most obvious being: