Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
syl20bnr committed Jun 19, 2024
1 parent 38810e4 commit adbef96
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,44 @@ cargo xtask pull-request-checks

**Pro-tip:** create an alias in your shell of choice to map `cargo xtask` to something easy to type like `cx`.

For bash:

```bash
nano ~/.bashrc

# add this to the file
alias cx='cargo xtask'

# save and source the file or restart the shell session
source ~/.bashrc
```

For fish:

```fish
nano ~/.config/fish/config.fish
# add this to the file
alias cx='cargo xtask'
# save and source the file or restart the shell session
source ~/.config/fish/config.fish
```

For powershell:

```powershell
notepad $PROFILE
# add this at the end of file
function cx {
cargo xtask $args
}
# save and quit then open a new powershell terminal
```

### Tests

To run the tests it is mandatory to use the `cargo xtask test` command as it makes sure that all
Expand Down

0 comments on commit adbef96

Please sign in to comment.