Skip to content

Commit

Permalink
Merge pull request #3 from maticnetwork/docs/install-info
Browse files Browse the repository at this point in the history
docs: Adding install info
  • Loading branch information
IdrisHanafi authored Oct 3, 2022
2 parents 93f96cb + f128bd2 commit 4f86fbe
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.org
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 4f86fbe

Please sign in to comment.