Skip to content

Latest commit

 

History

History
76 lines (39 loc) · 2.83 KB

README.md

File metadata and controls

76 lines (39 loc) · 2.83 KB

Readium

an open source library for handling EPUB documents

Readium is in early beta stages. The goal of the project is to create an open source set of libraries for viewing and developing EPUB 2.0.1 and EPUB 3 content. Currently the project is available as a google chrome extension that enables viewing of EPUB content in the browser. For high-level information see the Readium Project website.

Contributing

Readium is in active development and we are keen to build a community of developers to help make it awesome. If you would like to be invited as a contributor leave a message in the issue tracker or send Matthew an email

Dependencies

Google Chrome Version 15+

Install

If you are a developer interested in hacking on the project, clone the repository and then follow the instruction for loading an unpacked extension from the chrome extensions page

If you want to give the latest release a whirl, use teh one click install link below to add the extension to chrome.

Testing

We are using Jasmine to perform javascript unit tests. The best way to get these running is to install the Jasmine rubygem.

$ gem install jasmine

Then the specs can be run via the command:

$ rake jasmine

This will start a webserver running on port 8888. To run the spect navigate to (or refresh) localhost:8888.

License

BSD

Contributors

Contact

Download

You can download this project in either zip or tar formats.

You can also clone the project with Git by running:

$ git clone git://github.com/readium/readium

Attribution

Readium is an open source project, built on top of other open source projects. In addition to Chrome and WebKit, development of Readium would not have been possible without the following projects:

See also Readium Homepage in Github Pages.