Home

Awesome

Librum

Librum is an application designed to make reading <b>enjoyable</b> and <b>straightforward</b> for everyone.

It's not just an e-book reader. With Librum, you can manage your own online library and access it from any device anytime, anywhere. It has features like note-taking, AI tooling, and highlighting, while offering customization to make it as personal as you want!

Librum also provides free access to over 70,000 books and personal reading statistics while being free and completely open source.

<br>

Download Librum from our website!

<br>

Table of Contents

<br>

Preview

Setup and manage your own online library

HomeScreenDark

<br>

A simple and modern interface

image

<br>

Add your books to collections, tag them, and sort them in any way you want

folders_dark

<br>

Customize Librum to make it personal to you

image

<br>

Contributing

If you'd to support Librum's development, check out: https://librumreader.com/contribute <br> <br> All of the current feature requests, bugs and tasks are listed in the issues. Easy tasks are labeled "good first issue", so that is a good starting point. <br> <br> PS: Feel free to tag me (@DavidLazarescu) in the comments of any issue if you have questions.

<br>

Contact

For questions, you can reach us under: help@librumreader.com <br> For business related contact, reach out to us here: contact@librumreader.com

<br>

Donations

Donations make it possible for us to cover our server costs and allow us to make investments into new areas of development. <br> If you would like to support us, check out: https://librumreader.com/contribute/donate or become a Github sponsor! <br> <br> As a team of opensource developers we rely on donations to continue working on projects like Librum. Your help is greatly appreciated.

<br>

Translations

Librum is currently available in the languages listed here

If you want to translate Librum to another language, follow the steps below:

Once you are done, create a pull request or open up an issue with your new translation file!<br> If you run into any problems, need guidance or have questions, feel free to reach out to us at: contact@librumreader.com

<br>

Notes:

<br>

Documentation

For documentation go to Librum's GitHub-wiki

<br>

Self-hosting

To self-host Librum you need to run Librum-Server locally (instructions can be found here) and tell the client to use your self-hosted server by:

Make sure to run the application before following the steps above, to generate the required files.

<br>

Details

Supported platforms

Part of Librum's aim is to work on any platform. No matter where you are or which device you use, you can always continue your book with Librum, as it is <b>cross platform</b>.<br> We support:

Supported formats

Librum is the best choice for all kinds of books, since Librum supports <b>all</b> major book formats<br> including:

And many more!

<br>

Features

Librum's objective is to make your reading more <b>productive</b>; to that end, we provide you with a variety of features that you can access via a <b>simple</b> and <b>straightforward</b> interface.<br> These features include:

Want a new feature? Feel free to leave a feature request ticket!

<br><br>

Build Guide

Follow this guide to build Librum from source. <br>

For GNU/Linux

Prerequisites

Installation

The installation is straight forward, just follow the steps below:

<br>
  1. Clone the repository. 
    git clone https://github.com/Librum-Reader/Librum.git --recursive
  2. Step into the cloned project folder. 
    cd Librum
  3. Create the build folder and step into it. 
    mkdir build-Release
cd build-Release
  4. Run cmake. 
    cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTS=Off -DCMAKE_PREFIX_PATH=<path/to/Qt> ..
    Set CMAKE_PREFIX_PATH to your Qt installation path. Installing Qt via the online installer usually installs it to /home/<name>/Qt/<version>/gcc_64
  5. Build the project 
    cmake --build . -j $(nproc)
  6. Install Librum 
    cmake --install .
<br>

Troubleshooting

Here are solutions to some common errors. If your error is not listed here, please open an issue. <br>

<br>

For Windows

Prerequisites

Installation

To build Librum on windows, run the following commands in the Powershell:

<br>
  1. Clone the repository. 
    git clone https://github.com/Librum-Reader/Librum.git --recursive
  2. Step into the cloned project folder. 
    cd Librum
  3. Create the build folder and step into it. 
    mkdir build
cd build
  4. Run cmake. 
    cmake -DBUILD_TESTS=Off -DCMAKE_PREFIX_PATH=<path/to/qt> ..
    Set CMAKE_PREFIX_PATH to your Qt installation path. Installing Qt via the online installer usually installs it to <Drive>\\Qt\\<version>\\msvc2019_64
  5. Build the project 
    cmake --build . --config Release
  6. Run the app 
    ./librum

Additional Info

Here are some things to keep in mind during the build process. <br>

<br>

For MacOS

Prerequisites

Installation

The installation is straight forward, just follow the steps below:

<br>
  1. Clone the repository. 
    git clone https://github.com/Librum-Reader/Librum.git --recursive
  2. Step into the cloned project folder. 
    cd Librum
  3. Create the build folder and step into it. 
    mkdir build-Release
cd build-Release
  4. Run cmake. 
    cmake -DCMAKE_INSTALL_PREFIX=/usr/local -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTS=Off -DCMAKE_PREFIX_PATH=<path/to/Qt> ..
    Set CMAKE_PREFIX_PATH to your Qt installation path. Installing Qt via the online installer usually installs it to /Users/<name>/Qt/<version>/macos
  5. Build the project 
    cmake --build . -j $(nproc)
  6. Install Librum 
    cmake --install

Note: Make sure to add /usr/local/lib to your DYLIB path, for MacOS to find the installed libraries by exporting DYLD_LIBRARY_PATH=$DYLD_LIBRARY_PATH:/usr/local/lib.

<br>