1
0
mirror of https://github.com/casey/just synced 2024-06-29 06:24:38 +00:00

Create a short markdown readme for crates.io

This commit is contained in:
Casey Rodarmor 2017-10-14 23:18:46 -07:00
parent 7874e22d47
commit 0030878ad7
3 changed files with 25 additions and 3 deletions

2
Cargo.lock generated
View File

@ -1,6 +1,6 @@
[root]
name = "just"
version = "0.3.2"
version = "0.3.3"
dependencies = [
"ansi_term 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)",
"atty 0.2.3 (registry+https://github.com/rust-lang/crates.io-index)",

View File

@ -1,11 +1,11 @@
[package]
name = "just"
version = "0.3.2"
version = "0.3.3"
description = "🤖 Just a command runner"
authors = ["Casey Rodarmor <casey@rodarmor.com>"]
license = "WTFPL OR MIT OR Apache-2.0"
homepage = "https://github.com/casey/just"
readme = "README.asc"
readme = "crates-io-readme.md"
[dependencies]
ansi_term = "^0.9.0"

22
crates-io-readme.md Normal file
View File

@ -0,0 +1,22 @@
`just` is a handy way to save and run project-specific commands.
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}}
```
`just` produces detailed error messages and avoids `make`'s idiosyncrasies, so debugging a justfile is easier and less surprising than debugging a makefile.
It works on Linux, MacOS, and Windows.
Read more on [GitHub](https://github.com/casey/just).