actions
/
mdBook
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[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.
This commit is contained in:
Maxime BORGES 2020-12-23 19:03:31 +01:00 committed by GitHub
parent ba6bffac5a
commit 7af4b1dfe8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -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/