Skip to content

Commit c6e3549

Browse files
committed
updated readme
1 parent 110633e commit c6e3549

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

+9-7
Original file line numberDiff line numberDiff line change
@@ -15,24 +15,26 @@ To improve coverage and precision, we´ll persist in research efforts on static
1515

1616
## Quick Start
1717

18-
For a quick start, make sure that [Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) is installed on your computer. Then, install Scout dependencies by running the following command:
18+
**Install Scout Audit:**
1919

20-
```bash
21-
cargo install cargo-dylint dylint-link
22-
```
23-
24-
Afterwards, install Scout with the following command:
20+
Make sure that [Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) is installed on your computer. Then, install Scout with the following command:
2521

2622
```bash
2723
cargo install cargo-scout-audit
2824
```
2925

30-
To run Scout on your project, navigate to its root directory and execute the following command:
26+
**Run Scout Audit:**
27+
28+
To run Scout on your project execute the following command:
3129

3230
```bash
3331
cargo scout-audit
3432
```
3533

34+
:bulb: Scout supports [Cargo Workspaces](https://doc.rust-lang.org/book/ch14-03-cargo-workspaces.html). When run on a workspace, Scout will be executed on all packages specified as members of the workspace.
35+
36+
:warning: Make sure that your smart contracts compile properly. Scout won't run if any compilation errors exist.
37+
3638
For more information on installation and usage, please refer to the [Getting Started](https://coinfabrik.github.io/scout/docs/intro) section in our documentation below.
3739

3840
## Documentation

0 commit comments

Comments
 (0)