Skip to content

docs: add usage examples to Just section in README #2087

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mapaba79 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: add usage examples to Just section in README #2087

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,14 @@ The following BDK crates maintains a MSRV of 1.85.0. To build these crates with

This project has a [`justfile`](/justfile) for easy command running. You must have [`just`](https://github.com/casey/just) installed.

After forking and cloning this project with `git clone https://github.com/YOUR_USER/bdk.git`, you should build it and run the tests, just makes this process easier.

### Usage examples:

To build the project, run: `just b`

To run all tests, run: `just t`

To see a list of available recipes: `just`

## License
Expand Down