Skip to content
This repository was archived by the owner on Apr 11, 2021. It is now read-only.

Commit

Permalink
Add prerequistes to README
Browse files Browse the repository at this point in the history
Fixes #71
  • Loading branch information
smartcontracts authored Apr 7, 2021
1 parent 8cd92d4 commit 80e72f2
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down

0 comments on commit 80e72f2

Please sign in to comment.