Giter Club home page Giter Club logo

ocherbook's Introduction

OcherBook

Ocher handprint

Build Status

OcherBook is an open-source ebook reader, supporting multiple file formats and output devices. The major goals are:

  • Return control and privacy of the reading experience to the reader
  • Portable
  • Modular design
  • Small with few external dependencies.

Target Devices

Perhaps the largest distinguishing implementation detail of OcherBook is that its in-memory format is not DOM, and the rendering backends are not web browsers. Think DVI. Therefore it is not going to render complex books nearly as accurately, but it is far more portable and efficient. This may eventually turn out to be a mistake, but for now it's an advantage that I'm running with.

It also handles its own event loop and its own rendering, so it could potentially run on very limited devices. This is, perhaps, the singular charm of this project.

At the moment it's mostly tested on Kobo and SDL.

Building

Building is supported with Meson (native and cross-compile) and CMake (currently only native).

To get started, try something simple like:

$ cd OcherBook
$ meson builddir
$ cd builddir
$ ninja

Check the Wiki for more detailed instructions.

To cross-compile, look in toolchains for a toolchain file for your device. Each toolchain file should include some notes regarding how to acquire and install the cross-compiling toolchain, and how to configure OcherBook for it.

Many features are configurable. Some feature libraries can be disabled, or enabled to build against the system's libraries, or enabled to download and build from source (perhaps useful when cross-compiling). For details, see meson_options.txt or cmake_options.cmake.

License

OcherBook itself is GPLv3. See COPYING.

See docs/LICENSES for all relevant licenses.

ocherbook's People

Contributors

ccoffing avatar jdek avatar

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.