Skip to content

Commit

Permalink
Remove confusion about postinstall script
Browse files Browse the repository at this point in the history
closes #116
closes #114
  • Loading branch information
ysbaddaden committed Aug 9, 2016
1 parent db860ee commit e8dd5e5
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions SPEC.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,13 +194,19 @@ development_dependencies:

### scripts

Shards may run scripts automatically after certain actions. Scripts are mere
shell commands, and can either download and/or compile a library for example.
Shards may run scripts automatically after certain actions. The scripts
themselves are mere shell commands.

Only the `postinstall` hook is supported, and is run after installing or
upgrading a dependency. More hooks may be added later on.
#### postinstall

The `postinstall` hook of a dependency will be run whenever that dependency is
installed or upgraded in a project that requires it. This may be used to compile
a C library, to build tools to help working on the project, or anything else.

The script will be run from the dependency's installation directory, for example
`libs/foo` for a Shard named `foo`.

```yaml
scripts:
postinstall: cd src/scrypt && make
postinstall: cd src/libfoo && make
```

0 comments on commit e8dd5e5

Please sign in to comment.