From 80e72f2a17bf98f90db3a35d81b5d9d256e238f4 Mon Sep 17 00:00:00 2001 From: smartcontracts Date: Wed, 7 Apr 2021 13:32:29 -0700 Subject: [PATCH] Add prerequistes to README Fixes #71 --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 900b3b7..c93a475 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,17 @@ Contains an executable batch submitter service which watches L1 and a local L2 n ## Configuration All configuration is done via environment variables. See all variables at [.env.example](.env.example); copy into a `.env` file before running. +## Prerequisite Software + +Please make sure you've installed the following before continuing: + +- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) +- [Node.js](https://nodejs.org/en/download/) +- [Yarn](https://classic.yarnpkg.com/en/docs/install#mac-stable) +- `build-essential` +- `libusb-dev` +- `libudev-dev` + ## Building & Running 1. Make sure dependencies are installed just run `yarn` in the base directory 2. Build `yarn build`