-
-
Notifications
You must be signed in to change notification settings - Fork 132
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
282d9d8
commit 05182d3
Showing
1 changed file
with
27 additions
and
15 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 |
---|---|---|
|
@@ -10,6 +10,21 @@ ___ | |
|
||
Join us on [Discord](https://discord.gg/hSX64qsFHc) | ||
|
||
<br> | ||
|
||
# Table of Contents | ||
- [Preview](#Preview) | ||
- [Where can I get Librum?](#Where-can-I-get-Librum?) | ||
- [Contributing](#Contributing) | ||
- [Contact](#Contact) | ||
- [Donations](#Donations) | ||
- [Translations](#Translations) | ||
- [Documentation](#Documentation) | ||
- [Self-hosting](#Self-hosting) | ||
- [Details](#Details) | ||
- [Build Guide](#Build-Guide) | ||
|
||
<br> | ||
|
||
# Preview | ||
|
||
|
@@ -48,6 +63,18 @@ If you want to build Librum from source, follow the instructions [here](#build-g | |
|
||
<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](https://github.com/Librum-Reader/Librum/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: [email protected] | ||
|
@@ -104,21 +131,6 @@ For documentation go to [Librum's GitHub-wiki](https://github.com/Librum-Reader/ | |
|
||
<br> | ||
|
||
# Contributing | ||
|
||
If you'd like to contribute, check out: https://librumreader.com/contribute | ||
<br> | ||
<br> | ||
If you are interested in contributing, feel free to contact us on either:<br> | ||
1. Discord (m_david#0631) | ||
2. Email ([email protected]) | ||
<br> | ||
We are following a pull request workflow where every contribution is sent as a pull request and merged into the dev/develop branch for testing. <br> | ||
Please make sure to run clang format, keep to the conventions used throughout the application and ensure that all tests pass, before submitting any pull request. | ||
|
||
<br> | ||
<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`) | ||
|