Browse Source

Edit README.md

pull/5/head
mtardy 4 years ago
parent
commit
67c969a12a
1 changed files with 7 additions and 4 deletions
  1. +7
    -4
      README.md

+ 7
- 4
README.md View File

@ -1,8 +1,9 @@
# Javascrypt
## Requirements
## Build the project
### Requirements
Please install [peg/leg](https://www.piumarta.com/software/peg/) manually or with Homebrew:
Please install [peg/leg](https://www.piumarta.com/software/peg/) manually or with Homebrew:
```bash
$ brew install peg
```
@ -12,13 +13,13 @@ Please install [the Boehm-Demers-Weiser conservative garbage collector](https://
$ brew install bdw-gc
```
## Build
### Build
```bash
$ make
```
## Docker
## Build with Docker
The Docker image provides a ready to go environment to experiment with the project. Just build the image locally and run an interactive shell inside the container:
```bash
@ -26,6 +27,8 @@ $ docker build . --tag mtardy/javascrypt
$ docker run -it mtardy/javascrypt
```
---
## Usage
```bash

Loading…
Cancel
Save