Skip to content

Commit 7af4b1d

Browse files
authored
[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.
1 parent ba6bffa commit 7af4b1d

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,10 +91,11 @@ all its functionality as a Rust crate for integration in other projects.
9191
Here are the main commands you will want to run. For a more exhaustive
9292
explanation, check out the [User Guide].
9393

94-
- `mdbook init`
94+
- `mdbook init <directory>`
9595

9696
The init command will create a directory with the minimal boilerplate to
97-
start with.
97+
start with. If the `<directory>` parameter is omitted, the current
98+
directory will be used.
9899

99100
```
100101
book-test/

0 commit comments

Comments
 (0)