diff --git a/pages/common/bacon.md b/pages/common/bacon.md new file mode 100644 index 0000000000..28323f6c6b --- /dev/null +++ b/pages/common/bacon.md @@ -0,0 +1,28 @@ +# bacon + +> A background code checker for Rust. +> More information: . + +- Run `cargo check` whenever a change is detected in the current directory: + +`bacon` + +- Run `cargo test` whenever a change is detected in the given directory: + +`bacon test {{path/to/directory}}` + +- Run `cargo check` against all targets whenever a change is detected in the current directory: + +`bacon check-all` + +- Run a specific job whenever a change is detected in the current directory: + +`bacon {{run|test|clippy|doc|...}}` + +- List all currently available jobs: + +`bacon --list-jobs` + +- Initialize a `bacon.toml` configuration file in the current directory: + +`bacon --init`