Commit Graph

55 Commits

Author SHA1 Message Date
Quentin Nerden
88922b8974
Detail environment variable usage in readme (#1086) 2022-02-24 01:14:24 -08:00
Casey Rodarmor
fecb5e3f9d
Add hint for Node.js script compatibility (#1113) 2022-02-23 01:15:00 +00:00
Casey Rodarmor
a56af47e88
Release 1.0 (#1112) 2022-02-22 21:13:24 +00:00
Damian Kula
6271e94bc9
Add path_exists() function (#1106) 2022-02-21 21:45:30 +00:00
Casey Rodarmor
b4a0a8090d
Note that pipefail isn't normally set (#1108) 2022-02-17 22:02:03 +00:00
Casey Rodarmor
57d47fe59a
Fix dotenv-load documentation (#1104) 2022-02-15 20:20:52 +00:00
Greg Lutostanski
bcdaa95a66
Allow duplicate recipes (#1095) 2022-02-15 02:37:06 +00:00
Casey Rodarmor
0988a424ed
Add arrow pointing to table of contents button (#1096) 2022-02-10 17:15:35 +00:00
Austin Ziegler
4882b5aac0
Improve readme (#1093) 2022-02-08 20:30:25 +00:00
Casey Rodarmor
c3ba16ad74
Convert README.adoc to markdown (#1091) 2022-02-06 16:09:20 -08:00
Casey Rodarmor
6e3b43ac9e Overhaul README (#231)
- Switch to asciidoc, since it supports an auto-generated table of contents
- Re-organize into sections
- Document private recipes
- Document windows dependencies
- Document doc comments
2017-10-12 16:12:23 -07:00
Casey Rodarmor
35748f191f Add say thanks badge to readme (#215) 2017-08-16 21:19:39 -07:00
Jordan Danford
23f8881117 Fix typos in README.md (#213) 2017-08-07 13:35:05 -07:00
Casey Rodarmor
95ef27b32b Add a gitter badge (#170) 2017-04-18 22:18:36 -07:00
Casey Rodarmor
e45164da4d Improve syntax highlighting suggestions in readme (#164)
- Recognize Justfile as a justfile for vim filetypes snippet
- Add vim modeline and emacs local variables block
2017-03-12 19:20:33 -07:00
Casey Rodarmor
9c552fe8d0 readme: 'the in' -> 'in the' (#143) 2016-12-30 01:01:57 -08:00
Casey Rodarmor
b267d0444e Allow path-prefixed first arguments (#139)
If the first argument to just contains a `/`, then it will be handled
specially. Everything before the last `/` is treated as a directory, and
just will search for the justfile starting there, instead of in the
current directory.
2016-12-30 00:09:35 -08:00
Casey Rodarmor
86755582bb Readme: email -> issue (#138) 2016-12-15 18:48:31 -08:00
Casey Rodarmor
c6256333ed Lift limitations on recipes that take parameters (#137)
Previously, only one recipe with parameters could be passed on the
command line. This was to avoid confusion in case the number of
parameters a recipe took changed, and wound up using as an argument was
was once a recipe.

However, I don't think this is actually particularly confusing in
practice, and could be a slightly annoying limitation.

Now, any number of recipes with parameters may be given on the command
line.

Fixes #70
2016-12-10 16:35:52 -08:00
Casey Rodarmor
99e48fe2c6 Mention prebuilts in readme (#135) 2016-11-23 20:41:58 -08:00
Casey Rodarmor
1ac5b4ea42 Add variadic parameters (#127)
Recipes may now have a final variadic parameter:

```make
foo bar+:
  @echo {{bar}}
```

Variadic parameters accept one or more arguments, and expand to a string containing those arguments separated by spaces:

```sh
$ just foo a b c d e
a b c d e
```

I elected to accept one or more arguments instead of zero or more arguments since unexpectedly empty arguments can sometimes be dangerous. 

```make
clean dir:
  rm -rf {{dir}}/bin
```

If `dir` is empty in the above recipe, you'll delete `/bin`, which is probably not what was intended.
2016-11-18 07:03:34 -08:00
Casey Rodarmor
d11e679e4b Just is no longer a trival program ;_; (#120) 2016-11-15 19:29:41 -08:00
Casey Rodarmor
0ac2cdd124 Mention {{...}} substitution gotcha in readme (#117)
Fixes #116
2016-11-14 20:19:35 -08:00
Casey Rodarmor
3d7888708c Add multiline raw string example to readme (#109) 2016-11-13 14:21:34 -08:00
Casey Rodarmor
1e7a0fa63b Fix readme typo (#108)
'rather not rust' -> 'rather not install rust'
2016-11-13 14:07:04 -08:00
Casey Rodarmor
112462ec62 Toggle meaning of '@' on recipes prefixed with '@' (#100)
Fixes #65
2016-11-12 16:12:00 -08:00
Casey Rodarmor
7cfc37f647 Line up names in --evaluate (#93)
Fixes #66
2016-11-12 13:12:43 -08:00
Casey Rodarmor
6e8289c624 Make --list print recipes with arguments (#88)
Added `--summary` which just prints recipe names, like `--list` previous
to this change.

Fixes #75
2016-11-12 11:40:52 -08:00
Casey Rodarmor
886acf2f95 Let recipes take default arguments (#77)
Looks like this:

```make
recipe argument default-argument='default value':
  echo argument is {{argument}}
  echo default-argument is {{default-argument}}
```

Thanks @deckarep for the feature request!

Fixes #49
2016-11-12 09:15:13 -08:00
Casey Rodarmor
166c4bf48f Rename grammar.md to GRAMMAR.md (#73)
To match the `README.md` and `FAQ.md`
2016-11-11 23:09:40 -08:00
Casey Rodarmor
bd69f3298e Link to justfiles here and in the wild (#69) 2016-11-11 20:54:50 -08:00
Casey Rodarmor
f071f75c67 Improve recipes with parameters section of readme (#41) 2016-11-11 13:31:26 -08:00
Casey Rodarmor
ef39637c00 Add examples of comments to readme (#40)
Thanks @vitiral for suggesting this.
2016-11-11 13:04:47 -08:00
Jason Grlicky
1aebe92199 Fixed typo in Readme (#38)
`not.` -> `not`
2016-11-11 12:30:17 -08:00
Casey Rodarmor
d56ab91e8d Add build status badge to readme (#27) 2016-11-06 01:33:00 -07:00
Florian Gilcher
5d98bab31d Fix small typo in readme (#22)
suprising -> surprising
2016-11-05 13:13:27 -07:00
Casey Rodarmor
9a742e6336 Allow justfile to be named Justfile (#19)
Priority is given to `justfile` to match the behavior of GNU make.
2016-11-05 01:25:36 -07:00
Casey Rodarmor
7bc2be2caf Fix "whyc" typo in README.md 2016-11-04 23:18:20 -07:00
Casey Rodarmor
3b312e2728 Add escape sequences and raw strings to README.md 2016-11-02 00:09:58 -07:00
Casey Rodarmor
390491f7fa Readme done 2016-10-31 22:13:12 -07:00
Casey Rodarmor
398fb15c8b Readme. 2016-10-31 22:07:48 -07:00
Casey Rodarmor
763f73f0a8 Readme and notes 2016-10-31 22:06:28 -07:00
Casey Rodarmor
ed14b4d32a Readme wording 2016-10-31 22:05:31 -07:00
Casey Rodarmor
aeedf5ddff Mention overrides. 2016-10-31 22:03:27 -07:00
Casey Rodarmor
cef8b4fbdf Updated readme 2016-10-31 21:53:31 -07:00
Casey Rodarmor
ca9a0b7bff Update readme. 2016-10-31 21:27:10 -07:00
Casey Rodarmor
7f6a74af24 Rename arguments to parameters. 2016-10-31 19:11:27 -07:00
Casey Rodarmor
8a59d19cc7 Fix shield link 2016-10-30 22:47:29 -07:00
Casey Rodarmor
8de21fdc26 Add crates.io shield 2016-10-30 22:44:14 -07:00
Casey Rodarmor
8fd580dadd Notes and readme 2016-10-30 19:15:43 -07:00