diff options
| author | Maxime BORGES <contact@maximeborg.es> | 2020-12-23 19:03:31 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-12-23 10:03:31 -0800 |
| commit | 7af4b1dfe80903e3a2288355a2a396e7458866ee (patch) | |
| tree | b0828108972553d01e9bf1c8fd5d552888ca4c9d | |
| parent | ba6bffac5a2eac13a10b5fc91601dc167ef89449 (diff) | |
[README] Add optional directory parameter for the init command (#1409)
With the current description of the command, I was expecting to get a directory named with the project name, but the files were created in the current directory.
I Think a more precise description would help first-time users.
| -rw-r--r-- | README.md | 5 |
1 files changed, 3 insertions, 2 deletions
@@ -91,10 +91,11 @@ all its functionality as a Rust crate for integration in other projects. Here are the main commands you will want to run. For a more exhaustive explanation, check out the [User Guide]. -- `mdbook init` +- `mdbook init <directory>` The init command will create a directory with the minimal boilerplate to - start with. + start with. If the `<directory>` parameter is omitted, the current + directory will be used. ``` book-test/ |