README.md 2.09 KB
Newer Older
Wilko Manger's avatar
Wilko Manger committed
1
# Pattle
Wilko Manger's avatar
Wilko Manger committed
2

3
  [![](https://img.shields.io/matrix/app:pattle.im.svg?server_fqdn=matrix.org)](https://matrix.to/#/#app:pattle.im)
4
  
5
  ![Preview](/CHANGELOG/0.5.0.png)
6

Wilko Manger's avatar
Wilko Manger committed
7 8
  Pattle is an easy to use Android app for Matrix, with
  design inspired by other popular IM apps.
Wilko Manger's avatar
Wilko Manger committed
9

Wilko Manger's avatar
Wilko Manger committed
10 11 12 13 14
  The goal of Pattle is to create an app that behaves similiary
  (and almost exactly) like many modern popular chat apps of today,
  like WhatsApp, Telegram and Signal. This is not the only goal,
  however: the primary goal of Pattle is to be a Matrix app that
  everyone can use, in terms of simplicity.
Wilko Manger's avatar
Wilko Manger committed
15

Wilko Manger's avatar
Wilko Manger committed
16 17
  For more details, see the
  [design philosophy](https://docs.pattle.im/design/philosophy/).
Wilko Manger's avatar
Wilko Manger committed
18

Wilko Manger's avatar
Wilko Manger committed
19
## Get Pattle
20 21 22
  
  Pattle supports Android (from 4.1 and up) and iOS (from 8.0 and up), and in the
  future Pattle will also be available on desktop and the web.
23

24
### Android
25

Wilko Manger's avatar
Wilko Manger committed
26 27
  Pattle is available on [F-droid](https://f-droid.org/en/packages/im.pattle.app/)
  and [Google Play](https://play.google.com/store/apps/details?id=im.pattle.app)!
Wilko Manger's avatar
Wilko Manger committed
28

29
### iOS
Wilko Manger's avatar
Wilko Manger committed
30

Wilko Manger's avatar
Wilko Manger committed
31 32
  Pattle is available on TestFlight!
  [Follow the instructions here to install.](https://testflight.apple.com/join/uTytydST)
33 34
  
  Later on Pattle will be available in the App Store.
Wilko Manger's avatar
Wilko Manger committed
35 36

## Contributing
Wilko Manger's avatar
Wilko Manger committed
37

38 39
  Contributions are encouraged! See [CONTRIBUTING](CONTRIBUTING.md) for
  details on how to contribute!
Wilko Manger's avatar
Wilko Manger committed
40

41 42 43
  For many features, contributions might also be needed for the
  [Matrix Dart SDK](https://git.pattle.im/pattle/library/matrix-dart-sdk),
  which is developed for Pattle.
Wilko Manger's avatar
Wilko Manger committed
44 45 46

## Building

47 48
  Pattle is made with [Flutter](https://flutter.dev/). To build Pattle,
  you'll need the [Flutter SDK](https://flutter.dev/docs/get-started/install).
Wilko Manger's avatar
Wilko Manger committed
49

50 51 52
  Before building a debug build, make sure you have a `.env` file in the
  root of the project. You can just `cp .env.example .env`, because
  Sentry is not used in debug mode.
53

54 55 56 57
  Since Pattle uses the beta branch of the Flutter, make sure to
  switch to this branch by running `flutter channel beta`. Then,
  run `flutter upgrade`.

58 59 60
  After the Flutter SDK is setup and ready, you can build Pattle with:
  `flutter build apk` for Android, or
  `flutter build ios` for iOS.