Commit 74b154df authored by Daniel Wolf's avatar Daniel Wolf
Browse files

Added markdown file as guide to translations

parent 6afdf4a0
![Icon](app/src/main/res/mipmap-mdpi/ic_launcher_round.png)
![Icon](app/src/main/res/mipmap-mdpi/ic_launcher_round.png)
# Nebulo
Nebulo is a free, open-source, non-root and small sized DNS changer utilizing dns-over-https and dns-over-tls to bring privacy and security to your phone.
It is fast, contains no ads or tracking and offers a lot of flexibility.
# Help wanted
Requesting your support: the app is getting closer to a proper release but it's still missing an important aspect: translations.
Translations are important to reach as broad of an audience as possible and for non-english speakers to be able to use the app to it's full extent.
Head over to the [translation guide](TRANSLATING.md) to see how you can help!
# Installation
The app is distributed over the play store, F-Droid and as .apk file.
......@@ -70,10 +75,24 @@ This work contains third-party content, namely:
- License: [MIT](https://opensource.org/licenses/MIT)
- [Font Awesome icons](https://fontawesome.com/)
- License: Font Awesome Pro License, held by Daniel Wolf
- [Weblate](https://weblate.org) for managing translations
- License: GPLv3
# Cloning
Feel free to clone this software. However, there are a few things to notice:
- This app uses some of my own libraries which are only accessible when logged into this GitLab instance. Signing up is free and no tracking is in place.
- These libraries are distributed using an Artifactory server. This server is not public, but I do hand out credentials on request.
- Alternatively, replace the dependencies (`implementation 'com.frostnerd.utilskt:....`) with git sub-modules (`implementation project(...)`) after cloning the libraries.
- I own a Font Awesome Pro license and use a lot of their icons. Most of the icons used in this project are accessible with a Font Awesome Free license, but not all necessarily are. Either you have to own a license yourself, or check whether a particular icon is also usable with the Free license.
\ No newline at end of file
- I own a Font Awesome Pro license and use a lot of their icons. Most of the icons used in this project are accessible with a Font Awesome Free license, but not all necessarily are. Either you have to own a license yourself, or check whether a particular icon is also usable with the Free license.
</br>
</br>
</br>
<a href="https://weblate.frostnerd.com/engage/nebulo/?utm_source=widget">
<img src="https://weblate.frostnerd.com/widgets/nebulo/-/svg-badge.svg" alt="Übersetzungsstatus" />
</a>
[![pipeline status](https://git.frostnerd.com/PublicAndroidApps/smokescreen/badges/master/pipeline.svg)](https://git.frostnerd.com/PublicAndroidApps/smokescreen/commits/master)
\ No newline at end of file
# Help wanted
Whilst English is the second most spoken language there are a lot of people out there which don't speak it. To appeal to as big of an audience as possible and to make it possible for everyone to enjoy the security and privacy this app offers.
This is where you come in: I speak German and English but can't deliver any other translations. This is why I'd like to ask anyone who is willing to help to consider contributing translations or checking existing translations.
# How it's done
I use an web-based translations editor called [Weblate](weblate.org) (open-source software, available under the GPLv3) to make managing translations easy.
I host my [own instance of Weblate](https://weblate.frostnerd.com) -- [creating an account](https://weblate.frostnerd.com/accounts/register/) is free and neither does the site contain ads, nor does it use any tracking.
See below for a quick tutorial on how to use Weblate.
# The current state
Right now the app only contains German and English translations. Your help is needed.
<a href="https://weblate.frostnerd.com/engage/nebulo/?utm_source=widget">
<img src="https://weblate.frostnerd.com/widgets/nebulo/-/multi-green.svg" alt="Translation state" />
</a>
# Privacy policy
Privacy is important and as such the Weblate server is configured to collect as little data as possible.
You can generally use the service without creating an account, but if you do the following data is collected:
- Your e-mail address, used for logging in. This e-mail address is only going to be used for Weblate related topics.
- We won't contact you for non-Weblate related topics. Furthermore this e-mail address isn't given out to any third party.
- Your IP-address (only saved when trying to log in, or logging in), used in an audit log to combat spam and malicious actors.
- A session ID as a cookie to keep you logged in (only stored when logging in)
- A cookie is a small file on your device the website can read from and write to
Without creating an account (or trying to log in), no personal data is collected. IP addresses aren't logged on the HTTP server.
No collected data is shared with any third party.
No collected data is analyzed automatically except for the usages described above.
You can remove your account at any time. Simply do this by opening [this page](https://weblate.frostnerd.com/accounts/remove/) whilst logged in. You'll receive an e-mail with a link you have to click to delete your account. Deleting your account deletes your profile, completely removing your e-mail address from the database. Your IP addresses used in the past won't be deleted and stay in the audit log.
Feel free to contact me at daniel.wolf@frostnerd.com if you wish to know what data is saved about you, or if you wish it to be deleted.
# Quick tutorial
Here's a quick tutorial on how to contribute a translation.
1. Open [Weblate](https://weblate.frostnerd.com).
2. Sign in or create an account (free, no tracking, no ads)
- Your e-mail address will be saved with your hashed password. Your e-mail address is only used for the purpose of Weblate.
- After creating an account you'll receive an e-mail with a confirmation link.
3. When logged in, [open the project](https://weblate.frostnerd.com/projects/nebulo/).
4. [Select one of the components](material/translating/project_overview.png) you want to contribute a translation to
5. Choose an existing language, or [start translating to a new language](material/translating/start_translation)
- English is the default, it can't be edited
6. You'll be [shown a page](material/translating/component_overview.png) which gives an overview of the current translation state
7. [Select](material/translating/translation_overview.png) one of "All strings", "Strings needing action", "Not translated strings" or "Strings needing action without suggestions" or "Translated strings".
8. You'll be taken to the [translation editor](material/translating/translation_editor.png) (I choose "Not translated strings")
9. You can now select the translation source (English texts) and enter translations or suggestions for the language.
- You can also switch to [Zen mode](material/translating/translation_editor_zen.png) using the button in the right corner.
10. There is much more this tool is able to do, feel free to experiment (or read [the docs](https://docs.weblate.org/en/weblate-3.6.1/index.html))!
# License
All your translations become part of this project and are thus managed under the [GPLv3 license](LICENSE) .
The copyright stays with you, but you grant me (Daniel Wolf) and this project (Nebulo) the right to make use of all translations you create and the right to distribute them.
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment