Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/librum-reader/librum
The Librum client application
https://github.com/librum-reader/librum
cmake cpp ebook-reader ebooks library-management linux qml qt qt6 reader
Last synced: 24 days ago
JSON representation
The Librum client application
- Host: GitHub
- URL: https://github.com/librum-reader/librum
- Owner: Librum-Reader
- License: gpl-3.0
- Created: 2022-02-02T14:43:19.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-29T12:41:21.000Z (3 months ago)
- Last Synced: 2024-09-29T07:23:04.259Z (about 1 month ago)
- Topics: cmake, cpp, ebook-reader, ebooks, library-management, linux, qml, qt, qt6, reader
- Language: C++
- Homepage: https://librumreader.com
- Size: 28.6 MB
- Stars: 4,064
- Watchers: 36
- Forks: 124
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Librum
Librum is an application designed to make reading enjoyable and straightforward 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.
Download Librum from [our website](https://librumreader.com)!
# Table of Contents
- [Preview](#Preview)
- [Contributing](#Contributing)
- [Contact](#Contact)
- [Donations](#Donations)
- [Translations](#Translations)
- [Documentation](#Documentation)
- [Self-hosting](#Self-hosting)
- [Details](#Details)
- [Build Guide](#Build-Guide)
# Preview
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
# Contributing
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 the [issues](https://github.com/Librum-Reader/Librum/issues). 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.
# Contact
For questions, you can reach us under: [email protected]
For business related contact, reach out to us here: [email protected]
# Donations
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.
# Translations
Librum is currently available in the languages listed [here](https://github.com/Librum-Reader/Librum/tree/main/src/presentation/translations)
If you want to translate Librum to another language, follow the steps below:
- Download [this file](https://github.com/Librum-Reader/Librum/blob/dev/develop/src/presentation/translations/librum_en.ts)
- 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 from [here](https://github.com/thurask/Qt-Linguist) or using the [Qt Installer](https://www.qt.io/download-open-source)
- Now start Qt Linguist, open the downloaded file, set the target language to the language you want to translate to and start translating.
(Check out [this guide](https://youtu.be/xNIz78IPBu0?t=347) 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: [email protected]
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)
# Documentation
For documentation go to [Librum's GitHub-wiki](https://github.com/Librum-Reader/Librum/wiki)
# Self-hosting
To self-host Librum you need to run [Librum-Server](https://github.com/Librum-Reader/Librum-Server) locally (instructions can be found [here](https://github.com/Librum-Reader/Librum-Server#self-hosting)) and tell the client to use your self-hosted server by:
- (Linux) Editing ~/.config/Librum-Reader/Librum.conf and setting `selfHosted=true` and `serverHost` to your server's url (e.g. `serverHost=https://127.0.0.1:5001`)
- (Windows) Opening the registry editor (Press `Win + R` and search for `regedit`), navigating to `HKEY_CURRENT_USER\Software\Librum-Reader\Librum` and setting `selfHosted=true` and `serverHost` to your server's url
Make sure to run the application before following the steps above, to generate the required files.
# 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 cross platform.
We support:
- Windows
- GNU/Linux
- MacOS
- IOS (Coming Soon)
- Android (Coming Soon)
### Supported formats
Librum is the best choice for all kinds of books, since Librum supports all major book formats
including:
- PDF
- EPUB
- CBZ (Comic books)
- FB2
- TIFF
- Mobi
- XPS
- Images
And many more!
### Features
Librum's objective is to make your reading more productive; to that end, we provide you with a variety of features that you can access via a simple and straightforward 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!
# Build Guide
Follow this guide to build Librum from source.
## For GNU/Linux
### Prerequisites
- cmake (https://cmake.org/download)
- make (http://ftp.gnu.org/gnu/make)
- g++ (https://gcc.gnu.org)
- python3-venv (on ubuntu use `sudo apt install python3-venv`)
- Qt 6.5 (https://www.qt.io/download-open-source)
### Installation
The installation is straight forward, just follow the steps below:
1. Clone the repository.
```sh
git clone https://github.com/Librum-Reader/Librum.git --recursive
```
2. Step into the cloned project folder.
```sh
cd Librum
```
3. Create the build folder and step into it.
```sh
mkdir build-Release
cd build-Release
```
4. Run cmake.
```sh
cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTS=Off -DCMAKE_PREFIX_PATH= ..
```
Set `CMAKE_PREFIX_PATH` to your Qt installation path. Installing Qt via the online installer usually installs it to `/home//Qt//gcc_64`
6. Build the project
```sh
cmake --build . -j $(nproc)
```
7. Install Librum
```sh
cmake --install .
```
### Troubleshooting
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 its `sudo apt install libgl1-mesa-dev` and on fedora its `sudo 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 its `sudo apt install libxcb-cursor-dev`
## For Windows
### Prerequisites
- cmake (https://cmake.org/download)
- Visual Studio 19 (https://visualstudio.microsoft.com/de/vs/older-downloads)
- Python (https://www.python.org/downloads)
- Qt 6.5 (https://www.qt.io/download-open-source)
### Installation
To build Librum on windows, run the following commands in the Powershell:
1. Clone the repository.
```sh
git clone https://github.com/Librum-Reader/Librum.git --recursive
```
2. Step into the cloned project folder.
```sh
cd Librum
```
3. Create the build folder and step into it.
```sh
mkdir build
cd build
```
4. Run cmake.
```sh
cmake -DBUILD_TESTS=Off -DCMAKE_PREFIX_PATH= ..
```
Set `CMAKE_PREFIX_PATH` to your Qt installation path. Installing Qt via the online installer usually installs it to `\\Qt\\\\msvc2019_64`
6. Build the project
```sh
cmake --build . --config Release
```
7. Run the app
```sh
./librum
```
### Additional Info
Here are some things to keep in mind during the build process.
- Make sure to add cmake and the Qt binaries to the `PATH` environment variable
- You need Visual Studio 2019, newer versions will **not** work
- For the Qt installation, you **only** need to choose "MSVC 2019 64-bit", you can untick everything else to reduce the download size
## For MacOS
### Prerequisites
- 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)
### Installation
The installation is straight forward, just follow the steps below:
1. Clone the repository.
```sh
git clone https://github.com/Librum-Reader/Librum.git --recursive
```
2. Step into the cloned project folder.
```sh
cd Librum
```
3. Create the build folder and step into it.
```sh
mkdir build-Release
cd build-Release
```
4. Run cmake.
```sh
cmake -DCMAKE_INSTALL_PREFIX=/usr/local -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTS=Off -DCMAKE_PREFIX_PATH= ..
```
Set `CMAKE_PREFIX_PATH` to your Qt installation path. Installing Qt via the online installer usually installs it to `/Users//Qt//macos`
6. Build the project
```sh
cmake --build . -j $(nproc)
```
7. Install Librum
```sh
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`.