GitLab/fluffychat
2
0
Fork 0
mirror of https://gitlab.com/famedly/fluffychat.git synced 2024-11-27 06:39:25 +01:00
Code Issues Projects Releases Wiki Activity

docs: Update readme and contributing

Browse Source
This commit is contained in:
Krille Fear 2021-03-13 07:42:45 +00:00
parent dd6ae9f921
commit 449e46d789
2 changed files with 14 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
CONTRIBUTING.md
View File

@ -1,23 +1,21 @@
# How you can contribute to FluffyChat
Thanks for using FluffyChat and thanks for your decision to contribute. ❤❤❤ There are multiple ways how you can help us:
Thanks for using FluffyChat and thanks for your decision to contribute. ❤❤❤ There are multiple ways how you can help us.
## Code contributions
Pick one of the issues in the issue tracker, fork this project, fix the issue and create a merge request. Please be aware that this has to follow some rules:
- Your code changes should follow the clean code principles where it is possible
- You should test the changes on all platforms that are affected
- The CI pipeline must be green so you need to format the code correctly and follow the lint rules
- Please be aware that we always need to device if your changes fit in the project
## Social Media:
We always need help with social media stuff. We don't have much time and the time we have we spend in developing. So we often lack to spread news about new features to the world.
Just contact us at [#fluffychat:matrix.org](https://matrix.to/#/#fluffychat:matrix.org).
## Translations:
You can add translations for your language easily. Just download this file [intl_messages.arb](https://gitlab.com/ChristianPauly/fluffychat-flutter/-/raw/master/lib/l10n/intl_messages.arb) and translate it to your language. Then you can either send us the file and we add it to the project or you can do this by yourself in these steps (for more experienced users):
1. Create a GitLab account if you don't have one.
2. Fork the project.
3. Create a new .arb file in /lib/l10n and name it with the country code of your language. For example with klingon you name it **intl_kl.arb**.
4. (Optional) If you are a Flutter developer, execute this command to add the translations to the project:
```
flutter pub pub run intl_translation:generate_from_arb --output-dir=lib/l10n --no-use-deferred-loading lib/l10n/l10n.dart lib/l10n/intl_*.arb
```
5. Append the country code of your language to the list in the `isSupported` method at the top of `/lib/l10n/l10n.dart`, as well as to the `supportedLocales` list in `/lib/main.dart`.
6. Start a new Merge Request and become a hero. ❤❤❤
You can help with translations on [Weblate](https://hosted.weblate.org/projects/fluffychat/). To translate the website to your language, you need to fork the repository and edit the needed files.
## Bug reports:
Bug reporting and issue tracking is a huge task. We need help with:

38
README.md
View File

@ -1,38 +1,12 @@
![](https://i.imgur.com/wi7RlVt.png)
<p align="center">
<a target="new" href="https://play.google.com/store/apps/details?id=chat.fluffy.fluffychat">
<img height="66px" src="https://fluffychat.im/assets/images/google-play-badge.png" />
</a>
<a target="new" href="https://fluffychat.im/en/fdroid.html">
<img height="66px" src="https://fluffychat.im/assets/images/fdroid_button.png " />
</a>
<br>
<a href="https://web.fluffychat.im" target="new">Open FluffyChat in the browser</a> - <a href="https://matrix.to/#/#fluffychat:matrix.org" target="new">Join the community</a> - <a href="https://metalhead.club/@krille" target="new">Follow me on Mastodon</a> - <a href="https://hosted.weblate.org/projects/fluffychat/" target="new">Translate FluffyChat</a> - <a href="https://gitlab.com/ChristianPauly/fluffychat-website" target="new">Translate the website</a> - <a href="https://fluffychat.im" target="new">Website</a> - <a href="https://gitlab.com/ChristianPauly/fluffychat-flutter/-/jobs/artifacts/main/browse?job=build_android_apk" target="new">Download latest APK</a> - <a href="https://gitlab.com/famedly/famedlysdk" target="new">Famedly Matrix SDK</a> - <a href="https://famedly.com/kontakt">Server hosting and professional support</a>
<a href="https://matrix.to/#/#fluffychat:matrix.org" target="new">Join the community</a> - <a href="https://metalhead.club/@krille" target="new">Follow me on Mastodon</a> - <a href="https://hosted.weblate.org/projects/fluffychat/" target="new">Translate FluffyChat</a> - <a href="https://gitlab.com/ChristianPauly/fluffychat-website" target="new">Translate the website</a> - <a href="https://fluffychat.im" target="new">Website</a> - <a href="https://gitlab.com/famedly/famedlysdk" target="new">Famedly Matrix SDK</a> - <a href="https://famedly.com/kontakt">Server hosting and professional support</a>
</p>
<br>
<br>
# Features
* Single and group chats
* Send images and files
* Voice messages
* Offline chat history
* Push Notifications
* Account settings
* Display user avatars
* Themes, chat wallpapers and dark mode
* Device management
* Edit chat settings and permissions
* Kick, ban and unban users
* Display and edit chat topics
* Change chat & user avatars
* Archived chats
* Discover public chats on the user's homeserver
* Registration
* Disable account
* Change password
* End-To-End-Encryption
FluffyChat is a multi-platform Matrix client written in Dart/Flutter. It compiles to native code von Android, iOS, macOS, Windows and Linux and renders with Skia on the web. FluffyChat is just a hobby project from the developers of [Famedly](https://famedly.com) and licensed under AGPLv3. It follows a [design philosophy](https://ko-fi.com/post/FluffyChats-Design-Philosophy-W7W63A6YS) to be minimalistic, inclusive and easy to use.
# How to build
@ -67,14 +41,10 @@ sudo apt install ninja-build
* Enable web support in Flutter: https://flutter.dev/docs/get-started/web
* Optionally edit the file `lib/app_config.dart`. If you e.g. only want to change the default homeserver, then only modify the `defaultHomeserver` key.
* Build with:
```bash
./scripts/prepare-web.sh
flutter clean
flutter pub get
flutter build web --release --verbose
flutter build web --release
```
* Optionally configure by serving a `config.json` at the same path as fluffychat.
@ -94,7 +64,7 @@ flutter build macos --release
```
## How to add translations for your language
# How to add translations for your language
You can use Weblate to translate the app to your language: