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

Merge pull request #191 from jessestricker/readme-typos 

Fix some minor typos and text inconsistencies
This commit is contained in:
Mathieu David 2016-12-29 18:02:15 +01:00 committed by GitHub
parent f1df53a4bb b75243f1f5
commit 6410e792d7
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -21,7 +21,7 @@
</tr> </tr>
</table> </table>
mdBook is a utility to create modern online books from markdown files. mdBook is a utility to create modern online books from Markdown files.
**This project is still evolving.** **This project is still evolving.**
See [#90](https://github.com/azerupi/mdBook/issues/90) See [#90](https://github.com/azerupi/mdBook/issues/90)
@ -29,7 +29,7 @@ See [#90](https://github.com/azerupi/mdBook/issues/90)
## What does it look like? ## What does it look like?
The [**Documentation**](http://azerupi.github.io/mdBook/) for mdBook has been written in markdown and is using mdBook to generate the online book-like website you can read. The documentation uses the latest version on github and showcases the available features. The [**Documentation**](http://azerupi.github.io/mdBook/) for mdBook has been written in Markdown and is using mdBook to generate the online book-like website you can read. The documentation uses the latest version on GitHub and showcases the available features.
## Installation ## Installation
@ -47,12 +47,12 @@ There are multiple ways to install mdBook.
This will download and compile mdBook for you, the only thing left to do is to add the Cargo bin directory to your `PATH`. This will download and compile mdBook for you, the only thing left to do is to add the Cargo bin directory to your `PATH`.
3. **From Git** 3. **From Git**
The version published to Crates.io will ever so slightly be behind the version hosted here on Github. If you need the latest version you can build the git version of mdBook yourself. Cargo makes this ***super easy***! The version published to crates.io will ever so slightly be behind the version hosted here on GitHub. If you need the latest version you can build the git version of mdBook yourself. Cargo makes this ***super easy***!
``` ```
cargo install --git https://github.com/azerupi/mdBook.git cargo install --git https://github.com/azerupi/mdBook.git
``` ```
Again, make sure to add the Cargo bin directory to your `PATH` Again, make sure to add the Cargo bin directory to your `PATH`.
4. **For Contributions** 4. **For Contributions**
If you want to contribute to mdBook you will have to clone the repository on your local machine: If you want to contribute to mdBook you will have to clone the repository on your local machine:
@ -66,7 +66,7 @@ There are multiple ways to install mdBook.
cargo build cargo build
``` ```
the resulting binary can be found in `mdBook/target/debug/` under the name `mdBook` or `mdBook.exe` The resulting binary can be found in `mdBook/target/debug/` under the name `mdBook` or `mdBook.exe`.
@ -74,7 +74,7 @@ There are multiple ways to install mdBook.
mdBook will primaraly be used as a command line tool, even though it exposes all its functionality as a Rust crate for integration in other projects. mdBook will primaraly be used as a command line tool, even though it exposes 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 [documentation](http://azerupi.github.io/mdBook/). Here are the main commands you will want to run. For a more exhaustive explanation, check out the [documentation](http://azerupi.github.io/mdBook/).
- `mdbook init` - `mdbook init`
@ -106,7 +106,7 @@ Here are the main commands you will want to run, for a more exhaustive explanati
### As a library ### As a library
Aside from the command line interface, this crate can also be used as a library. This means that you could integrate it in an existing project, like a web-app for example. Since the command line interface is just a wrapper around the library functionality, when you use this crate as a library you have full access to all the functionality of the command line interface with and easy to use API and more! Aside from the command line interface, this crate can also be used as a library. This means that you could integrate it in an existing project, like a web-app for example. Since the command line interface is just a wrapper around the library functionality, when you use this crate as a library you have full access to all the functionality of the command line interface with an easy to use API and more!
See the [Documentation](http://azerupi.github.io/mdBook/lib/lib.html) and the [API docs](http://azerupi.github.io/mdBook/mdbook/index.html) for more information. See the [Documentation](http://azerupi.github.io/mdBook/lib/lib.html) and the [API docs](http://azerupi.github.io/mdBook/mdbook/index.html) for more information.
@ -123,4 +123,4 @@ You can pick any issue you want to work on. Usually it's a good idea to ask if s
## License ## License
All the code is released under the ***Mozilla Public License v2.0***, for more information take a look at the [LICENSE](LICENSE) file All the code is released under the ***Mozilla Public License v2.0***, for more information take a look at the [LICENSE](LICENSE) file.