Skip to content

Commit 8ae7d6d

Browse files
committed
Expand the README a bit.
1 parent 00e4a33 commit 8ae7d6d

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,18 @@ test command still succeeds. If it does, it keeps that visibility; otherwise it
1111
tries the next in the list. As this suggests, `depub` is destructive: it
1212
overwrites files, so do not run it on source code that you do not want altered!
1313

14-
A standard way to run it is:
14+
For example, if you want to reduce visibility of a normal build, `cd` to your
15+
Rust code base and execute:
1516

1617
```
17-
$ cargo run depub -- -c "cargo check"
18+
$ /path/to/depub -- -c "cargo check"
19+
```
20+
21+
The string specified with `-c` is passed straight to `/bin/sh` so can be any
22+
shell command. If you want to test multiple features you might use:
23+
24+
```
25+
$ /path/to/depub -- -c "cargo check && cargo check --features f1"
1826
```
1927

2028
`depub` informs you of its progress. After it is finished, `diff` your code

0 commit comments

Comments
 (0)