Giter Club home page Giter Club logo

beru's Introduction

Basic Ebook Reader for Ubuntu

Beru is an ebook reader for Ubuntu. It's built on the the new Ubuntu Toolkit, so it works best on touch devices. It behaves resonably on the desktop, as well. Beru features full support for Epub files and preliminary support for CBZ and PDF files. Watch the progress at http://rschroll.github.io/beru/.

Building

You will need the Ubuntu SDK. To build out-of-tree, do

$ mkdir <build directory>
$ cd <build directory>
$ cmake <path to source>
$ make

Note that Qt Creator will do this automatically for you.

In-tree builds should work, but will not be as tested.

Running

Launch Beru with the shell script beru.

Beru keeps a library of epub files. On every start, a specified folder is searched and all epubs in it are included in the library. You may also pass a epub file to beru as an argument. This will open the file and add it to your library.

The Library is stored in a local database. While I won't be cavalier about changing the database format, it may happen. If you're getting database errors after upgrading, delete the database and reload your files. The database is one of the ones in ~/.local/share/com.ubuntu.developer.rschroll.beru/Databases; read the .ini files to find the one with Name=BeruLocalBooks.

Click Packages

The install option target can be used to help build click packages. First, run cmake with the -DCLICK_MODE=ON option. Then run from the build directory

make DESTDIR=<directory> install

This will fill the directory with the contents for the click package, which may be assembed with

click build <directory>

To build clicks from within Qt Creator, add -DCLICK_MODE=ON to the CMake arguments of the build settings.

Note that the click package contains .so files, and is therefore limited to the architecture on which it was produced. To produce click packages for other architectures, you'll need to cross compile.

Known Problems

Known bugs are listed on the issue tracker. If you don't see your problem listed there, please add it!

beru's People

Contributors

rschroll avatar randy-jr-olive avatar

Watchers

Gregory Naughton avatar James Cloos 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.