Skip to content

Commit

Permalink
Add instructions for usage with dfx
Browse files Browse the repository at this point in the history
  • Loading branch information
kritzcreek committed Aug 31, 2020
1 parent 2bdf166 commit a8d34fa
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,21 @@ A simple package manager for the Motoko programming language.

1. Download a copy of the `vessel` binary from the release page or build one yourself
2. Run `vessel init` in your project root.
3. Edit `vessel.dhall` to include your dependencies (potentially also
edit `package-set.dhall` to include additional package sources)
4. Run `$(vessel bin)/moc $(vessel sources) main.mo` to compile the `main.mo` file
3. Edit `vessel.dhall` to include your dependencies (potentially also edit
`package-set.dhall` to include additional package sources)
4. In a dfx project: Edit `dfx.json` under defaults->build->packtool to say `"vessel sources"` like so:
```
...
"defaults": {
"build": {
"packtool": "vessel sources"
}
}
...
```
Then run `dfx build`
4. In a non-dfx project:
Run `$(vessel bin)/moc $(vessel sources) main.mo` to compile the `main.mo` file
with the installed packages in scope

## How it works
Expand Down

0 comments on commit a8d34fa

Please sign in to comment.