Skip to content

Commit

Permalink
Adding installation instructions (#19)
Browse files Browse the repository at this point in the history
  • Loading branch information
mtlynch committed Nov 27, 2019
1 parent e8135b0 commit 959ffe4
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Expand Up @@ -12,3 +12,19 @@ Specifically:
* Enforces style rules on docstrings using [DocStringChecker](https://chromium.googlesource.com/chromiumos/chromite/+/master/cli/cros/lint.py)
* Perfoms static analysis with [pyflakes](https://github.com/megies/pyflakes)
* Sorts imports with [isort](https://github.com/timothycrosley/isort)

## Installation

```bash
mkdir -p ./venv
virtualenv --python python3 ./venv
. venv/bin/activate
pip install --requirement requirements.txt
pip install --requirement dev_requirements.txt
```

## Run

```bash
./app/main.py
```

0 comments on commit 959ffe4

Please sign in to comment.