Code Monkey home page Code Monkey logo

easybook's Introduction

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 website.

Installation

easybook can be installed in three different ways depending upon your needs:

  1. ZIP instalation: best suited for users who want to try easybook features as fast and easy as possible.
  2. Composer installation: recommended for regular users who want to use easybook for publishing books and documentation.
  3. Git installation: reserved for advanced developers who want to hack and modify easybook.

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

$ cd easybook-installation-dir
$ ./book

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

1. ZIP installation

  1. Download easybook.zip file.
  2. Uncompress easybook.zip file in any directory.

2. Composer installation

# create a directory for easybook
$ mkdir easybook

# install easybook and all its dependencies in 'easybook' directory
$ composer create-project easybook/easybook easybook

This method requires that Composer is previously installed on your system. Execute the following commands to install Composer globally:

$ curl -s http://getcomposer.org/installer | php
$ sudo mv composer.phar /usr/local/bin/composer

3. Git installation

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

# download vendors and dependencies
$ cd easybook
$ composer install

This method requires that Composer is previously installed on your system. Execute the following commands to install Composer globally:

$ curl -s http://getcomposer.org/installer | php
$ sudo mv composer.phar /usr/local/bin/composer

Documentation

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

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 

easybook's People

Contributors

ghinda avatar javiereguiluz avatar magabriel avatar marijn avatar mavimo avatar raulfraile avatar

Watchers

 avatar  avatar

Forkers

satorutakahashi

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.