1
0
Fork 0
mirror of https://github.com/lise-henry/crowbook synced 2024-05-28 14:06:29 +02:00

First chapter of book example is now actually README.md

This commit is contained in:
Elisabeth Henry 2016-02-21 04:36:10 +01:00
parent 10cdd50322
commit d93adc5880
2 changed files with 2 additions and 63 deletions

View File

@ -25,6 +25,6 @@ output_odt: book.odt
# finally, our files
# paths are relative to the directory where this file is
+ introduction.md
+ config.md
+ ../README.md
+ config.md

View File

@ -1,61 +0,0 @@
Introduction
============
What is Crowbook
----------------
As its name suggests, Crowbook is a tool to render books and, more
specifically, books written in *Markdown*. Its primary target are
novels, with a focus on generating PDF and Epub files.
This doesn't mean that it is impossible to use Crowbook for
technical documentations (though some features, like footnotes, *are*
actually currently unsupported), but the result won't probably be as
beautiful as tools that are more focused to that, such as
[mdBook](https://github.com/azerupi/mdBook). Let's see an example with
code formatting:
```rust
fn main() {
println!("Hello, world!");
}
```
Now, that's not nearly as nice as cool syntax highlighting and even
the possibility to actually run the code in your browser. But that's
OK because, again, Crowbook is focused on novels, and you don't
expect to see a lot of programming in a novel.
*****
At the opposite, having a decent separation ruler to separate lists of
paragraphs, and not some ugly line, is more relevant to our objectives.
Installing Crowbook
-------------------
Crowbook is written in [Rust](https://www.rust-lang.org/), so you'll
first need to install the Rust compiler, which you can
[download here](https://www.rust-lang.org/downloads.html) if you don't
already have it.
Then you'll need to clone the github repository of Crowbook and run
`cargo build` in it:
```bash
$ git clone https://github.com/lise-henry/crowbook.git
$ cd crowbook
$ cargo build
```
Then you'll have two options: either run `crowbook` directly in this
directory, with `cargo run`, or install it with `cargo install`.
Either way, you'll need to pass it a configuration file. E.g., to
generate this book, you'll do:
```
$ cargo run book_example/config.book
```