Skip to content

Commit 3ae6bf1

Browse files
authored
docs(contributing): use cargo-xtask for intructions (#1509)
- Updates `CONTRIBUTING.md` about the usage of `xtask` - Removes `Makefile.toml`
1 parent ec30390 commit 3ae6bf1

2 files changed

Lines changed: 7 additions & 166 deletions

File tree

CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ guarantee that the behavior is unchanged.
3131

3232
### Code formatting
3333

34-
Run `cargo make format` before committing to ensure that code is consistently formatted with
34+
Run `cargo xtask format` before committing to ensure that code is consistently formatted with
3535
rustfmt. Configuration is in [`rustfmt.toml`](./rustfmt.toml).
3636

3737
### Search `tui-rs` for similar work
@@ -56,7 +56,7 @@ documented.
5656

5757
### Run CI tests before pushing a PR
5858

59-
Running `cargo make ci` before pushing will perform the same checks that we do in the CI process.
59+
Running `cargo xtask ci` before pushing will perform the same checks that we do in the CI process.
6060
It's not mandatory to do this before pushing, however it may save you time to do so instead of
6161
waiting for GitHub to run the checks.
6262

@@ -71,17 +71,17 @@ in GitHub docs.
7171

7272
### Setup
7373

74-
Clone the repo and build it using [cargo-make](https://sagiegurari.github.io/cargo-make/)
74+
TL;DR: Clone the repo and build it using `cargo xtask`.
7575

7676
Ratatui is an ordinary Rust project where common tasks are managed with
77-
[cargo-make](https://github.com/sagiegurari/cargo-make/). It wraps common `cargo` commands with sane
77+
[cargo-xtask](https://github.com/matklad/cargo-xtask). It wraps common `cargo` commands with sane
7878
defaults depending on your platform of choice. Building the project should be as easy as running
79-
`cargo make build`.
79+
`cargo xtask build`.
8080

8181
```shell
8282
git clone https://github.com/ratatui/ratatui.git
8383
cd ratatui
84-
cargo make build
84+
cargo xtask build
8585
```
8686

8787
### Tests
@@ -182,7 +182,7 @@ We use GitHub Actions for the CI where we perform the following checks:
182182
- The code should conform to the default format enforced by `rustfmt`.
183183
- The code should not contain common style issues `clippy`.
184184

185-
You can also check most of those things yourself locally using `cargo make ci` which will offer you
185+
You can also check most of those things yourself locally using `cargo xtask ci` which will offer you
186186
a shorter feedback loop than pushing to github.
187187

188188
## Relationship with `tui-rs`

Makefile.toml

Lines changed: 0 additions & 159 deletions
This file was deleted.

0 commit comments

Comments
 (0)