Repository files navigation

Librum is an application designed to make readingenjoyable andstraightforward for everyone.

It's notjust 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.

Download Librum fromour website!

• Preview
• Contributing
• Contact
• Donations
• Translations
• Documentation
• Self-hosting
• Details
• Build Guide

Setup and manage your own online library

A simple and modern interface

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

Customize Librum to make it personal to you

If you'd to support Librum's development, check out:https://librumreader.com/contribute

All of the current feature requests, bugs and tasks are listed in theissues. Easy tasks are labeled "good first issue", so that is a good starting point.

PS: Feel free to tag me (@DavidLazarescu) in the comments of any issue if you have questions.

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

Donations make it possible for us to cover our server costs and allow us to make investments into new areas of development.
If you would like to support us, check out:https://librumreader.com/contribute/donate or become a Github sponsor!

As a team of opensource developers we rely on donations to continue working on projects like Librum. Your help is greatly appreciated.

Librum is currently available in the languages listedhere

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

• Downloadthis file
• Rename the file to contain your language's suffix, e.g. "librum_ru.ts" for Russian or "librum_de.ts" for German
• Download the translation software (Qt Linguist) either for Windows fromhere or using theQt Installer
• Now start Qt Linguist, open the downloaded file, set the target language to the language you want to translate to and start translating.(Check outthis guide for a quick overview of Qt Linguist)

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

Notes:

• Make sure that your translations are approximately the same length as the original text
• Please carefully check for spelling mistakes (including punctuation and capitalization)

For documentation go toLibrum's GitHub-wiki

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

• (Linux) Editing ~/.config/Librum-Reader/Librum.conf and settingselfHosted=true andserverHost to your server's url (e.g.serverHost=https://127.0.0.1:5001)
• (Windows) Opening the registry editor (PressWin + R and search forregedit), navigating toHKEY_CURRENT_USER\Software\Librum-Reader\Librum and settingselfHosted=true andserverHost to your server's url

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

Part of Librum's aim is to work onany platform. No matter where you are or which device you use, you can always continue your book with Librum, as it iscross platform.
We support:

• Windows
• GNU/Linux
• MacOS
• IOS (Coming Soon)
• Android (Coming Soon)

Librum is the best choice for all kinds of books, since Librum supportsall major book formats
including:

• PDF
• EPUB
• CBZ (Comic books)
• FB2
• TIFF
• Mobi
• XPS
• Images

And many more!

Librum's objective is to make your reading moreproductive; to that end, we provide you with a variety of features that you can access via asimple andstraightforward interface.
These features include:

• A modern e-reader
• A personalized and customizable online library
• Book meta-data editing
• A free in-app bookstore with more than 70,000 books
• Book syncing across all of your devices
• Highlighting
• Bookmarking
• Text search
• Unlimited customization
• Fine-grained organization through Librum's folder system
• Note-taking (Coming Soon)
• TTS (Coming Soon)
• Personalized reading statistics (Coming Soon)

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

Follow this guide to build Librum from source.

• cmake (https://cmake.org/download)
• make (http://ftp.gnu.org/gnu/make)
• g++ (https://gcc.gnu.org)
• python3-venv (on ubuntu usesudo apt install python3-venv)
• Qt 6.5 (https://www.qt.io/download-open-source)

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

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-Releasecd build-Release

4. Run cmake.

   cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTS=Off -DCMAKE_PREFIX_PATH=<path/to/Qt> ..

   SetCMAKE_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.

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

• Error:Failed to find required Qt component "Quick".
  

• Solution: Install the libGL mesa dev package, on ubuntu itssudo apt install libgl1-mesa-dev and on fedora itssudo dnf install mesa-libGL-devel.

• Error:Could not load the qt platform plugin "xcb" even though it was found

• Solution: Install the libxcb-cursor-dev, on ubuntu itssudo apt install libxcb-cursor-dev

• cmake (https://cmake.org/download)
• Visual Studio19 (https://visualstudio.microsoft.com/de/vs/older-downloads)
• Python (https://www.python.org/downloads)
• Qt 6.5 (https://www.qt.io/download-open-source)

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

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 buildcd build

4. Run cmake.

   cmake -DBUILD_TESTS=Off -DCMAKE_PREFIX_PATH=<path/to/qt> ..

   SetCMAKE_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

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

• Make sure to add cmake and the Qt binaries to thePATH environment variable
• You need Visual Studio 2019, newer versions willnot work
• For the Qt installation, youonly need to choose "MSVC 2019 64-bit", you can untick everything else to reduce the download size

• cmake (https://cmake.org/download)
• make (http://ftp.gnu.org/gnu/make)
• g++ (https://gcc.gnu.org)
• python3 (https://www.python.org/downloads)
• Qt 6.5 (https://www.qt.io/download-open-source)

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

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-Releasecd build-Release

4. Run cmake.

   cmake -DCMAKE_INSTALL_PREFIX=/usr/local -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTS=Off -DCMAKE_PREFIX_PATH=<path/to/Qt> ..

   SetCMAKE_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 exportingDYLD_LIBRARY_PATH=$DYLD_LIBRARY_PATH:/usr/local/lib.