Add examples of comments to readme (#40)

Thanks @vitiral for suggesting this.
This commit is contained in:
Casey Rodarmor 2016-11-11 13:04:47 -08:00 committed by GitHub
parent 1aebe92199
commit ef39637c00
2 changed files with 7 additions and 3 deletions

View File

@ -9,14 +9,16 @@ just
Commands are stored in a file called `justfile` or `Justfile` with syntax inspired by `make`:
```make
build:
cc *.c -o main
# test everything
test-all: build
./test --all
# run a specific test
test TEST: build
./test --test {{TEST}}
build:
cc *.c -o main
```
`just` produces detailed error messages and avoids `make`'s idiosyncrasies, so debugging a justfile is easier and less surprising than debugging a makefile.
@ -47,6 +49,7 @@ Recipes look like this:
recipe-name:
echo 'This is a recipe!'
# this is a comment
another-recipe:
@echo 'Another recipe.'
```

View File

@ -1,6 +1,7 @@
test: build
cargo test --lib
# only run tests matching PATTERN
filter PATTERN:
cargo test --lib {{PATTERN}}