Skip to content

Latest commit

 

History

History
68 lines (43 loc) · 1.88 KB

README.md

File metadata and controls

68 lines (43 loc) · 1.88 KB

easybook

«book publishing as easy as it should be»

easybook lets you easily publish books in various electronic formats (PDF, ePub and HTML). It was originally designed to publish technical programming books, but you can use easyboook to publish any kind of book, manual or documentation.

Installation

Regular users not using Git:

  1. Download easybook.zip file
  2. Uncompress easybook.zip file

Advanced users using Git:

# clone easybook repository
$ mkdir easybook
$ git clone http://github.com/javiereguiluz/easybook.git easybook

# download composer and install easybook vendors
$ cd easybook
$ curl -s http://getcomposer.org/installer | php
$ php composer.phar install

Regardless the way you install it, use easybook with the book command:

$ cd easybook
$ ./book

If the last command doesn't work, try php book or check book script permissions.

Documentation

easybook is fully documented at http://easybook-project.org/doc/

Examples

easybook-examples is a repository with several examples of how to use easybook to produce advanced and high quality books. This is by far the best way to learn easybook.

License

easybook is licensed under the MIT license.

Tests

Execute the following command to test easybook (requires PHPUnit):

$ cd easybook
$ phpunit

Travis CI status: Travis CI status

Requirements

In order to generate PDF files, PrinceXML library must be installed. If you haven't installed it yet, you can download a fully-functional demo at:

http://www.princexml.com/download