Skip to content
Snippets Groups Projects
Unverified Commit 33d9ef7f authored by Shaopeng Wang's avatar Shaopeng Wang Committed by GitHub
Browse files

Update readme. (#312)

* Update readme.

* Copy Cargo.toml commands in README.
parent c1edb3de
No related branches found
No related tags found
No related merge requests found
...@@ -33,12 +33,20 @@ Checkout [orml-workshop](https://github.com/xlc/orml-workshop) for example usage ...@@ -33,12 +33,20 @@ Checkout [orml-workshop](https://github.com/xlc/orml-workshop) for example usage
### Makefile targets ### Makefile targets
- `make check` - `make check`
- Type check the code, without std feature, exclduing tests. - Type check the code, without std feature, excluding tests.
- `make check-tests` - `make check-tests`
- Type check the code, with std feature, including tests. - Type check the code, with std feature, including tests.
- `make test` - `make test`
- Run tests. - Run tests.
### `Cargo.toml`
ORML use `Cargo.dev.toml` to avoid workspace conflicts with project cargo config. To use cargo commands in ORML workspace, create `Cargo.toml` by running
- `cp Cargo.dev.toml Cargo.toml`, or
- `make Cargo.toml`, or
- change the command to `make dev-check` etc which does the copy. (For the full list of `make` commands, check `Makefile`)
# Projects using ORML # Projects using ORML
_In alphabetical order_ _In alphabetical order_
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment