From 33d9ef7f490dcde3c6d76e005c14546c2904b97b Mon Sep 17 00:00:00 2001 From: Shaopeng Wang <spxwang@gmail.com> Date: Thu, 12 Nov 2020 16:04:29 +1300 Subject: [PATCH] Update readme. (#312) * Update readme. * Copy Cargo.toml commands in README. --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 62392d7..460583d 100644 --- a/README.md +++ b/README.md @@ -33,12 +33,20 @@ Checkout [orml-workshop](https://github.com/xlc/orml-workshop) for example usage ### Makefile targets - `make check` - - Type check the code, without std feature, exclduing tests. + - Type check the code, without std feature, excluding tests. - `make check-tests` - Type check the code, with std feature, including tests. - `make test` - 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 _In alphabetical order_ -- GitLab