README.rdoc in bookshop-0.1.3

- old
+ new

@@ -5,11 +5,13 @@
 Bookshop is a an open-source book development and publishing framework for authors, editors, publishers and coders in today's publishing industry. Bookshop provides best-practices for developing your books in HTML/CSS/JS, allowing them to be transformed into potentially any book format (Print-PDF, PDF, mobi, ePub, etc.).
 
 A conceptual overview of bookshop: http://blueheadblog.blogspot.com/2012/03/announcing-bookshop-html-to-pdf-ebook.html
 
 bookshop hopes to simplify the process by:
+
 * using common tools like HTML/CSS to make the creation of your book comfortable and familiar, greatly reducing the learning curve for your developers, authors, agents, and other team members
+* separating the "book" into its logical parts: Content via HTML (words, grammar, tense), Structure via microformat (chapters, sections), Style via css (layout, design, typeset), and Format (pdf, mobi, epub, html)
 * providing a Ruby Gem to make building a book in HTML as easy as 'gem install bookshop'
 * pulling all the html-to-pdf/(e)book tools together into one place (princexml, kindlegen, epubcheck)
 * 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)
 
@@ -22,11 +24,11 @@
 (not required, but recommended for using other tools)
 * Java 1.5 or higher http://www.java.com/en/
 
 == Installation
 
-For detailed instructions for your particular platform, please see this link:
+For detailed installation instructions for your particular platform, please see this link:
 
 https://github.com/blueheadpublishing/bookshop/wiki/Setting-Up-Your-bookshop-Environment
 
 === Install bookshop
 
@@ -223,26 +225,28 @@
 
 http://www.princexml.com/doc/8.0/
 
 ==== Editing you epub document and options
 
+We decided to keep away from a generator model for the epub, in favor of allowing the developer to have full control of the epub file in all its aspects. The build command for epub is merely to build the main html file from the .erb source files and then to zip them up into the epub format.
+
 There are two main files (besides your actual book source) you will need to edit for the epub build are located in the +book/epub/OEBPS+ folder: content.opf (the Open Packaging Format) and the toc.ncx (the Navigation file).
 
-During the build process, the entire contents of the +book/epub/+ folder will be used, along with your book source files, to create your epub book format. You can add or edit any of the files in that folder if you like. Generally speaking, you will probably only ever edit the content.opf.erb and the toc.ncs.erb files.
+===== 1. The *content.opf* file is the file which contains all of the primary information about your epub ebook (publisher, files included, date, etc.). 
 
-http://idpf.org/epub/30 - For an overview of EPUB
-http://idpf.org/epub/30/spec/epub30-ocf.html - For the specs on the epub file structures and contents
+http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm - Specs on the .opf file
 
-We recommend consulting the EPUB documentation for specifics.
+===== 2. The toc.ncx file is the file which contains the structural tree of your book's navigation.
 
-===== The *content.opf* file is the file which contains all of the primary information about your epub ebook (publisher, files included, date, etc.). 
+http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.4.1.2 - Specs on the .ncx file.
 
-http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm - Specs on the .opf file
+During the build process, the entire contents of the +book/epub/+ folder will be used, along with your book source files, to create your epub book format. You can add or edit any of the files in that folder if you like. Generally speaking, you will probably only ever edit the content.opf.erb and the toc.ncx.erb files.
 
-===== The toc.ncx file is the file which contains the structural tree of your book's navigation.
+http://idpf.org/epub/30 - For an overview of EPUB
+http://idpf.org/epub/30/spec/epub30-ocf.html - For the specs on the epub file structures and contents
 
-http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.4.1.2 - Specs on the .ncx file.
+We recommend consulting the EPUB documentation for specifics.
 
 == Example Book
 
 We've provided an example book for you already in the +book/+ folder. You can use this as an example of how to structure your book and to use ERB, Book Variables, and Output Variables.
 
@@ -309,38 +313,16 @@
 4. Add tests so that we don't accidentally break your addition with our future commits.
 5. Commit to your git (forked) repository.
 6. Let us know about your code and we'll review/merge it into the master.
 7. And pat yourself on the back for contributing to an open source project!!
 	
-== Copyright (MIT-LICENSE)
+== License
 
 Copyright (C) 2011, 2012 by BlueHead Publishing, Inc (http://blueheadpublishing.com)
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Bookshop is available under either The "New" BSD License or The MIT License
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
-
-== The Boom Microformat License - boom.css (from which the css microformat was based)
-
-http://www.alistapart.com/articles/boom
-
-    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
+Please see the LICENSE file for further information
 
 == Thanks
 
 We would like to thank:
 
\ No newline at end of file