lib/bookshop/generators/bookshop/app/templates/README.rdoc in bookshop-0.0.14 vs lib/bookshop/generators/bookshop/app/templates/README.rdoc in bookshop-0.0.15
- old
+ new
@@ -1,10 +1,11 @@
== Welcome to bookshop
bookShop is a publishing framework for html-to-(e)book toolchain happiness and sustainable productivity. The framework is optimized to help developers quickly ramp-up, allowing them to more rapidly jump in and develop their html-to-(e)book (print-pdf, epub, mobi, etc.) flows, by favoring convention over configuration, setting them up with best practices, standards and tools from the start.
bookshop hopes to simplify the process by:
+* using common developer tools like HTML, CSS, etc. to make the creation of your book comfortable and familiar, greatly reducing the learning curve for your developers, authors, agents, and other team members
* providing a Ruby Gem to make building a book from HTML as easy as 'sudo gem install bookshop'
* pulling all the html-to-(e)book tools together into one place (wkhtmltopdf, kindlegen, epubcheck)
* sticking with open-source tools
* giving the developer a set of scripts to automate the redundant stuff
* providing an architecture/structure that follows best-practices and simplification (DRY... Don't Repeat Yourself)
@@ -49,42 +50,42 @@
* If you can't issue bookshop from your command line, make sure you have included your gems folder in your system $PATH. In unix you can add the following to your .bashrc file in your home folder (this example is for Ubuntu 10.10):
PATH="$PATH:/var/lib/gems/1.8/bin"
export PATH
-=== Building Your First Book
+=== Editing Your New Book
-To build a pdf format of your book from the html source:
+All of the source documents/code/assets (yay... HTML/CSS) for your book are stored in the +book/+ folder. The master file, from which everything is built is +book/book.html.erb+. Since this is an ERB file, you can do all kinds of things like:
- $ bookshop build pdf
+* embed ruby functions and calls
-== Getting Help
+ <p>Today is <%= Time.now.strftime('%A') %>.</p>
-* bookshop comes with a built in help feature. Simply run 'bookshop --help' from the command line to get list of possible commands to issue including possible options. You can also run 'bookshop COMMAND --help' (where COMMAND is the command you want) to get a list of possible options for that particular command
+ or
-== Thanks
+ <ul>
+ <% for @item in @shopping_list %>
+ <li><%= @item %></li>
+ <% end %>
+ </ul>
+
+* include other files or template structures
+* explore other creative ways to structure and enhance your book (we'd love to see how you are doing it)
-We would like to thank:
+When the book is built, your master +book/book.html.erb+ file will be compiled into the final HTML which will be used to build the book types.
-* The Ruby/Rubygems Team www.ruby-lang.org/
-* The Thor Team - https://github.com/wycats/thor
-* Hakon Wium Lie and Bert Bos for developing the book microformat http://www.alistapart.com/articles/boom
-* The WKHTMLTOPDF team http://code.google.com/p/wkhtmltopdf/
-* The EPUBCHECK team http://code.google.com/p/epubcheck/
+When you are finished editing your source you can build whichever type of your book that you would like. Currently the only supported builds are pdf and html (and soon epub and mobi).
-== Description of Gem Contents
+=== Building Your First Book
-The basic bookshop gem architecture:
+To build a pdf format of your book from the html source:
- |-- bin
- |-- lib
+ $ bookshop build pdf
-bin
- command file copied to /usr/bin upon installation (which is then called from the command line)
+== Getting Help
-lib
- bookshop gem library files
+* bookshop comes with a built in help feature. Simply run 'bookshop --help' from the command line to get list of possible commands to issue including possible options. You can also run 'bookshop COMMAND --help' (where COMMAND is the command you want) to get a list of possible options for that particular command
== Description of bookshop app contents
The default directory structure of a generated bookshop project:
@@ -152,6 +153,16 @@
== The Boom Microformat License (as listed in the boom.css)
Sample style sheet for boom!, the book microformat
written by Hakon Wium Lie and Bert Bos, November 2005
- You may reuse this style sheet for any purpose without any fees
+ You may reuse this style sheet for any purpose without any fees
+
+== Thanks
+
+We would like to thank:
+
+* The Ruby/Rubygems Team www.ruby-lang.org/
+* The Thor Team - https://github.com/wycats/thor
+* Hakon Wium Lie and Bert Bos for developing the book microformat http://www.alistapart.com/articles/boom
+* The WKHTMLTOPDF team http://code.google.com/p/wkhtmltopdf/
+* The EPUBCHECK team http://code.google.com/p/epubcheck/
\ No newline at end of file