From f128bd2037d66aad379819ebdbb6e99625b0fc84 Mon Sep 17 00:00:00 2001 From: idrishanafi Date: Fri, 30 Sep 2022 09:14:00 -0400 Subject: [PATCH] docs: Adding install info --- README.org | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.org b/README.org index 34e1409f..67ba512f 100644 --- a/README.org +++ b/README.org @@ -17,6 +17,24 @@ often have inconsistent tooling and this makes automation and operations painful. The goal of this codebase is to standardize some of our commonly needed tools and provide interfaces and formats. +* Install + +Requirements: +- [[https://go.dev/][Go]] + +To install, clone this repo and run: +#+begin_src bash +$ make install +#+end_src + +By default, the commands will be in ~$HOME/go/bin/~, so for ease, +we recommend adding that path to your shell's startup file by +adding the following line: + +#+begin_src bash +export PATH="$HOME/go/bin:$PATH" +#+end_src + * Hash The ~hash~ command provides a simple mechanism to perform hashes on