An open API service indexing awesome lists of open source software.

https://github.com/geometryzen/stemcbook

Book for STEMCstudio
https://github.com/geometryzen/stemcbook

Last synced: 4 months ago
JSON representation

Book for STEMCstudio

Awesome Lists containing this project

README

          

= The STEMCstudio Book

The source code for the STEMCstudio Book.

== How To Generate the Book

You can generate the e-book files manually with Asciidoctor.
If you run the following you _may_ actually get HTML, Epub, Mobi and PDF output files:

----
$ bundle install
$ bundle exec rake book:build
Converting to HTML...
-- HTML output at stemcbook.html
Converting to EPub...
-- Epub output at stemcbook.epub
Converting to Mobi (kf8)...
-- Mobi output at stemcbook.mobi
Converting to PDF...
-- PDF output at stemcbook.pdf
----

You can generate just one of the supported formats (HTML, EPUB, mobi, or PDF).
Use one of the following commands:

To generate the HTML book:

----
$ bundle exec rake book:build_html
----

To generate the EPUB book:

----
$ bundle exec rake book:build_epub
----

To generate the mobi book:

----
$ bundle exec rake book:build_mobi
----

To generate the PDF book:

----
$ bundle exec rake book:build_pdf
----

== Signaling an Issue

Before signaling an issue, please check that there isn't already a similar one in the bug tracking system.

Also, if this issue has been spotted on the git-scm.com site, please cross-check that it is still present in this repo.
The issue may have already been corrected, but the changes have not been deployed yet.

== Contributing

If you'd like to help out by making a change, take a look at the link:CONTRIBUTING.md[contributor's guide].