Closes #257.

Fixes #254 and #255.

.github/CONTRIBUTING.md

@@ -8,9 +8,9 @@ Please read the guidelines before contributing, and follow them (or try to) when
 
 ### What you can do to help.
 
-There are many ways to contribute to this project, you could report bugs, request missing features, suggest enhancements and changes to existing ones. You also can improve the README with useful tips that could help the other users.
+There are many ways to contribute to this project, you could [translate the app](https://crowdin.com/project/readerforselfoss), report bugs, request missing features, suggest enhancements and changes to existing ones. You also can improve the README with useful tips that could help the other users.
 
-You can fork the repository, and [help me solve some issues](https://github.com/aminecmi/ReaderforSelfoss/labels/help%20wanted) or [develop new things](https://github.com/aminecmi/ReaderforSelfoss/issues)
+You can fork the repository, and [help me solve some issues](https://github.com/aminecmi/ReaderforSelfoss/issues?q=is%3Aissue+is%3Aopen+label%3A%22Up+For+Grabs%22) or [develop new things](https://github.com/aminecmi/ReaderforSelfoss/issues)
 
 ### What I can't help you with.
 
@@ -28,10 +28,11 @@ Always check if the web version of your instance is working.
 
 ### Pull requests
 
+* Don't create a PR for translations. See [here](https://github.com/aminecmi/ReaderforSelfoss/pull/170#issuecomment-355715654) for an explanation why.
 * Please ask before starting to work on an issue. I may be working on it, or someone else could be doing so.
 * Each pull request should implement **ONE** feature or bugfix. Keep in mind that you can submit as many PR as you want.
 * Your code must be simple and clear enough to avoid using comments to explain what it does.
-* Follow the used coding style [the official one](https://kotlinlang.org/docs/reference/coding-conventions.html) ([some idoms for reference](http://kotlinlang.org/docs/reference/idioms.html)) with more to come.
+* Follow the used coding style [the android koding style](https://android.github.io/kotlin-guides/style.html) ([some idoms for reference](http://kotlinlang.org/docs/reference/idioms.html)) with more to come.
 * Try as much as possible to write a test for your feature, and if you do so, run it, and make it work.
 * Always check your changes and discard the ones that are irrelevant to your feature or bugfix.
 * Have meaningful commit messages.
@@ -40,36 +41,33 @@ Always check if the web version of your instance is working.
 * Remember that PR review can take time.
 
 
+# Install Selfoss (if you don't have an instance)
+
+I won't provide any selfoss instance url. If you want to help, but to not have one, you'll have to install one, and use it.
+
+All the details to need are [here](https://selfoss.aditu.de/).
+
 # Build the project
 
 You can directly import this project into IntellIJ/Android Studio.
 
 You'll have to:
 
-- Configure fabric and add your `apiKey` and `apiSecret` in the `fabric.properties` file.
-- Create a firebase project and add the `google-services.json` to the `app/` folder.
-- Define the following some parameters either in `~/.gradle/gradle.properties` or as gradle parameters (see the examples)
+- Define some parameters either in `~/.gradle/gradle.properties` or as gradle parameters (see the examples)
 
-    - mercuryApiKey: A [Mercury](https://mercury.postlight.com/web-parser/) web parser api key for the internal browser
-    - feedbackEmail: An email to receive users  feedback.
-    - sourceUrl: an url to the source code, used in the settings
-    - trackerUrl: an url to the tracker, used in the settings
+    - appLoginUrl, appLoginUsername and appLoginPassword: url, username and password of a selfoss instance. **These are only used for tests. They can be empty if you don't test API calls.**
 
 ### Examples:
 #### Inside ~/.gradle/gradle.properties
 
 ```
-appLoginUrl="URL"
-appLoginUsername="LOGIN"
-appLoginPassword="PASS"
-mercuryApiKey="LONGAPIKEY"
-feedbackEmail="EMAIL"
-sourceUrl="URLSOURCE"
-trackerUrl="URLTRACKER"
+appLoginUrl="URL" # It can be empty.
+appLoginUsername="LOGIN" # It can be empty.
+appLoginPassword="PASS" # It can be empty.
 ```
 
 #### As gradle parameters
 
 ```
-./gradlew .... -P appLoginUrl="URL" -P appLoginUsername="LOGIN" -P appLoginPassword="PASS" -P mercuryApiKey="LONGAPIKEY" -P feedbackEmail="EMAIL" -P sourceUrl="URLSOURCE" -P trackerUrl="URLTRACKER"
+./gradlew .... -P appLoginUrl="URL" -P appLoginUsername="LOGIN" -P appLoginPassword="PASS"
 ```