Skip to content

Commit

Permalink
meta: Fix documentation related to invoking paper-muncher through ck.
Browse files Browse the repository at this point in the history
  • Loading branch information
sleepy-monax committed Sep 11, 2024
1 parent fcb33fe commit 850fac7
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions doc/handbook.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ As a team we believe that building exceptional software requires strongs opinion

## Essential Commands

* `./ck builder run paper-muncher inspector <input document>`: Start the development environment.
* `./ck builder run --debug paper-muncher inspector <input document>`: For debugging.
* `./ck builder run --profile paper-muncher inspector <input document>`: For profiling (requires `perf` and `speedscope` to be installed).
* `./ck builder run --mixins=release paper-muncher inspector <input document>` Build the release version.
* `./ck builder run paper-muncher -- inspector <input document>`: Start the development environment.
* `./ck builder run --debug paper-muncher -- inspector <input document>`: For debugging.
* `./ck builder run --profile paper-muncher -- inspector <input document>`: For profiling (requires `perf` and `speedscope` to be installed).
* `./ck builder run --mixins=release paper-muncher -- inspector <input document>` Build the release version.
* `./ck builder test` Run all tests.
* `./ck builder clean` Clean the build directory.

Expand Down
2 changes: 1 addition & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The reign of wkhtmltopdf is over. The Paper Muncher has come. Let its name be et
```sh
# on Linux or MacOS
./ck builder run paper-muncher inspector <input document>
./ck builder run paper-muncher -- inspector <input document>

# windows support comming soon'ish
```
Expand Down

0 comments on commit 850fac7

Please sign in to comment.