diff --git a/README.md b/README.md index 6026c72d1..b8d8c9c65 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,21 @@ ___ Join us on [Discord](https://discord.gg/hSX64qsFHc) +
+ +# 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) + +
# Preview @@ -48,6 +63,18 @@ If you want to build Librum from source, follow the instructions [here](#build-g
+# 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: help@librumreader.com @@ -104,21 +131,6 @@ For documentation go to [Librum's GitHub-wiki](https://github.com/Librum-Reader/
-# Contributing - -If you'd like to contribute, check out: https://librumreader.com/contribute -
-
-If you are interested in contributing, feel free to contact us on either:
-1. Discord (m_david#0631) -2. Email (contact@librumreader.com) -
-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.
-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. - -
-
- # 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`)