Update guide to show how to use --proofread

book_example/arguments.md

@@ -12,6 +12,7 @@ USAGE:
 FLAGS:
     -h, --help            Prints help information
     -l, --list-options    Lists all possible option
+    -p, --proofread       Enable roofreading
     -s, --single          Use a single Markdown file instead of a book configuration file
     -V, --version         Prints version information
     -v, --verbose         Print warnings in parsing/rendering
@@ -21,7 +22,8 @@ OPTIONS:
     -o, --output <FILE>                Specifies output file
         --print-template <TEMPLATE>    Displays the default value of a template
         --set <KEY_VALUES>             Sets a list of book options
-    -t, --to <FORMAT>                  Generate specific forma [values: epub, pdf, html, tex, odt]
+    -t, --to <FORMAT>
+            Generate specific format [values: epub, pdf, html, tex, odt, proofread.html, proofread.html_dir, proofread.pdf, proofread.tex]
 
 ARGS:
     <BOOK>    File containing the book configuration, or a Markdown file when called with --single
@@ -34,7 +36,6 @@ where <BOOK> is[^1]:
 [the configuration file](config.md).
 
 
-
 ```bash
 $ crowbook foo/bar.book --to pdf --output baz.pdf
 ```
@@ -176,6 +177,11 @@ $ crowbook foo.book --set author Foo --title Bar
 
 will override the book title to `Bar` and its author to `Foo`.
 
+`--proofread`
+-------------
+
+Equivalent to `--set proofread true`. Enable proofreading. See [Proofreading](proofreading.md).
+
 `--list-options`
 ----------------
 

book_example/config.md

@@ -408,6 +408,10 @@ usage of some of them is detailed later on.
     -  Output file name for PDF rendering with proofread features
 
 ### Proofreading options (only for output.proofread.* targets) ###
+- **`proofread`**
+    - **type**: boolean
+    - **default value**: `false`
+    - Activate generation of proofreading copies
 - **`proofread.nb_spaces`**
     - **type**: boolean
     - **default value**: `true`

book_example/proofreading.md

@@ -35,6 +35,35 @@ $ cargo build --release --features "proofread"
 > in the source directory.
 
 
+Enabling proofreading
+---------------------
+
+Since proofreading can take quite a lot of time, particularly for long
+book, it is disabled by default. You'll have to run
+
+```bash
+$ crowbook --proofread my.book
+```
+
+or
+
+```bash
+$ crowbook -p my.book
+```
+
+to generate proofreading copies. Alternatively, if you want it to be
+activated each time you run `crowbook` on this book (which is *not*
+recommanded for long books, particularly if you want to perform a
+grammar check), you can set 
+
+```yaml
+proofread: true
+```
+
+in the book configuration file.
+
+
+
 Repetition detection 
 --------------------