-
-
Notifications
You must be signed in to change notification settings - Fork 131
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added new features & Updated old information
- Loading branch information
1 parent
0241e47
commit cb0e4f1
Showing
1 changed file
with
31 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,20 +4,28 @@ Librum is an application designed to make reading <b>enjoyable</b> and <b>straig | |
|
|
||
| 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. | ||
| Librum also provides free access to over 70.000 books and personal reading statistics while being free and completely open source. | ||
|
|
||
|
|
||
| # Preview | ||
|
|
||
| Setup and manage your own online library | ||
|
|
||
|  | ||
|
|
||
| <br> | ||
|
|
||
| A simple and modern interface | ||
|
|
||
|  | ||
|
|
||
|
|
||
| <br> | ||
|
|
||
| Setup and manage your own library | ||
| Add your books to collections, tag them, and sort them in any way you want | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
| <br> | ||
|
|
||
|
|
@@ -36,6 +44,14 @@ If you want to build Librum from source, follow the instructions [here](#build-g | |
|
|
||
| <br> | ||
|
|
||
| # Contact | ||
|
|
||
| For questions, you can reach us under: [email protected] | ||
| <br> | ||
| For business related contact, reach out to us here: [email protected] | ||
|
|
||
| <br> | ||
|
|
||
| # Donations | ||
|
|
||
| Donations make it possible for us to cover our server costs and allow us to make investments into new areas of development. | ||
|
|
@@ -53,23 +69,28 @@ Librum is currently available in: | |
| - English | ||
| - German | ||
| - Russian | ||
| - Ukrainian | ||
| - Indonesian | ||
| - Italian | ||
| - Korean | ||
| - Portuguese | ||
| - Mandarin | ||
|
|
||
| If you want to translate Librum to another language, follow the steps below: | ||
| - Download the file at: https://github.com/Librum-Reader/Librum/blob/main/src/presentation/translations/librum_en.ts | ||
| - 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 https://github.com/thurask/Qt-Linguist or using the Qt Installer at https://www.qt.io/download-open-source | ||
| - 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. | ||
| (For a quick guide on Qt Linguist, check out: https://youtu.be/xNIz78IPBu0?t=347) | ||
| (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 an issue with your new translation file!<br> | ||
| 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: [email protected] | ||
|
|
||
| <br> | ||
|
|
||
| Notes: | ||
| - Make sure that your translations are approximately the same length as the original text | ||
| - Make sure that you keep to the punctuation and capitalisation | ||
| - Please carefully check for spelling mistakes (including punctuation and capitalization) | ||
|
|
||
| <br> | ||
|
|
||
|
|
@@ -94,14 +115,6 @@ Please make sure to run clang format, keep to the conventions used throughout th | |
| <br> | ||
| <br> | ||
|
|
||
| # Contact | ||
|
|
||
| For questions, you can reach us under: [email protected] | ||
| <br> | ||
| For business related contact, reach out to us here: [email protected] | ||
|
|
||
| <br> | ||
|
|
||
| # 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`) | ||
|
|
@@ -141,18 +154,18 @@ including: | |
| 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: | ||
| - A modern e-reader | ||
| - A personalized and customizable library | ||
| - 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) | ||
| - No-login book reading (Coming Soon) | ||
|
|
||
| Want a new feature? Feel free to leave a feature request ticket! | ||
|
|
||
|
|
||