Librum

Librum's objective is to make reading as enjoyable and straightforward as possible.

Librum offers a wide range of options, that may be accessed via a modern and straightforward interface.
Librum allows you to create and manage your own library of books and documents, which you can access from any device.
You can read your book comfortably through the app, highlight sections that interest you, and bookmark pages that you wish to return to.
Other features of Librum include taking notes directly from the app, a free in-app bookstore, productivity-boosting plugins, and many more.

The primary goals of Librum are to be modern, entirely opensource, cost-free, customizable and fast. Due to the complete copyleft license we are utilizing, anyone can download, edit, and redistribute the source code.

Note: Librum is currently in development, and many fundamental features have yet to be implemented!

Details

By Librum supported platforms:

• Windows
• GNU/Linux
• MacOS
• IOS
• Android

Feature list:

• E-Book reading
• Free in-app bookstore
• Cross-platform
• Book state syncing
• Highlighting
• Bookmarks
• Tags
• Note taking
• Chapter navigation
• TTS
• Automated page scrolling
• Syncing with 3rd parties (Google drive, dropbox, nextcloud)
• Book meta-data editing
• Library management
• Custom plugins
• Fine grained appearance customization
• Application behavior customization
• Statistics (optional)
  • Total time spent read
  • Daily reading avarage
  • Days read in a row
  • Books read in a week/month/year
  • Total books read
• No-login book reading
• Sharing / Priting books

Librum supports all major book formats, these include:

• PDF
• PS
• Tiff
• CHM
• DjVu
• Images
• DVI
• XPS
• Fiction Book
• Comic Book
• Plucker
• Pub
• Fax

Getting started

Instructions to get Librum up and running in your environment.

For GNU/Linux

Prerequisites

• cmake (at least version 3.20) https://cmake.org/download/
• make (or any other build system) http://ftp.gnu.org/gnu/make/
• Qt6 https://www.qt.io/download
• Gcc (or any other c++ compiler) https://gcc.gnu.org/

Installation

1. Clone the repository.

   git clone --recurse-submodules -j8 https://github.com/Etovex/Librum.git
   

2. Step into the cloned project folder.

   cd Librum
   

3. Add the Qt path to the CMakeLists.txt
   By default, Qt creator appends the path to Qt to the 'CMAKE_PREFIX_PATH' variable, you have 2 options for building Librum:
   

   • Use Qt Creator to build the project (Simply open the CMakeLists.txt through Qt Creator, by clicking File -> Open File or Project...)
   • Add the path manually, for that, just copy this line

     list(APPEND CMAKE_PREFIX_PATH "/home/<username>/Qt/<Version>/<compiler>")
     

     to the third line of the top-level CMakeLists.txt and replace all contents in angular brackets '<>' with your data, for example:

     list(APPEND CMAKE_PREFIX_PATH "/home/david/Qt/6.2.3/gcc_64")
     

4. Create the build folder and step into it.

   mkdir build-Release
   cd build-Release
   

5. Run cmake.

   cmake -DCMAKE_BUILD_TYPE:STRING=Release -DBUILD_TESTS=Off ..
   

   If you don't want to use your default build-file generator (e.g. make, or ninja), add the -G option, e.g.

   -G "Ninja"
   

6. Build the project

   make
   

7. Run the app

   ./appLibrum
   

For Windows

Not yet officially supported. Support coming soon!

For macOS

Not yet officially supported. Support coming soon!