Skip to content

Commit

Permalink
Updated doc
Browse files Browse the repository at this point in the history
  • Loading branch information
rgarrigue committed Apr 27, 2020
1 parent 00b2440 commit ad667ec
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ cargo install mdbook mdbook-epub

If this is the first time, adapt `./book.toml` (authors, title, language) and `./.github/workflows/main.yml` (asset_path and asset_name).

Write your chapters in `./src/` folder, as `.md` files.
Write your chapters in `./src/` folder, as `.md` files.

Then update the `SUMMARY.md`. Running `./generate_summary.sh` is enough for my own usage, it generate one based on alphabetical order.
Then update the `SUMMARY.md`. Running `./generate_summary.sh` is enough for my own usage, it generates one based on alphabetical order, naming chapters by files names.

## Generate the ebook

Run `mdbook build`. The result will be in `./book/` folder, you can copy the `./book/epub/Songbook.epub` on your eReader straight away.

To automate this I added a Github Actions, so it'll be done on each git tag and published in Github release.
To automate this I added a Github Actions, so it'll be done on each git tag, the `.pub` file being published in Github release and the `html` directory as Github Pages.

0 comments on commit ad667ec

Please sign in to comment.