From 7af4b1dfe80903e3a2288355a2a396e7458866ee Mon Sep 17 00:00:00 2001 From: Maxime BORGES Date: Wed, 23 Dec 2020 19:03:31 +0100 Subject: [PATCH] [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. --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 082f460b..7c5b32f0 100644 --- a/README.md +++ b/README.md @@ -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 ` The init command will create a directory with the minimal boilerplate to - start with. + start with. If the `` parameter is omitted, the current + directory will be used. ``` book-test/