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

Add prerequistes to README #74

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add prerequistes to README #74

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
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/)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could add a .nvmrc and node to package.json

- [Yarn](https://classic.yarnpkg.com/en/docs/install#mac-stable)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could add .yarnrc also

- `build-essential`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are platform specific so they should be under a header that says Ubuntu
build-essential is required for a C/C++ compiler so that node-gyp can use it

- `libusb-dev`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

libusb is optional

- `libudev-dev`

## Building & Running
1. Make sure dependencies are installed just run `yarn` in the base directory
2. Build `yarn build`
Expand Down