mirror of
https://codeberg.org/Mercury-IM/Mercury-IM
synced 2025-02-07 20:06:24 +01:00
Add some info to README
This commit is contained in:
parent
dfa75972d9
commit
9e3718c0a1
1 changed files with 11 additions and 2 deletions
13
README.md
13
README.md
|
@ -1,8 +1,12 @@
|
|||
# Messenger
|
||||
|
||||
## Used Design Methods:
|
||||
Mercury-IM will be an XMPP messenger that aims to be portable.
|
||||
Most of the core logic is pure Java, so the final goal is to make it as easy as possible
|
||||
to add different UIs for different platforms on top of it.
|
||||
|
||||
* Mercury IM's development follows architectural principles know from
|
||||
## Developing:
|
||||
|
||||
* Mercury IM's development tries to follow architectural principles know from
|
||||
[Clean Architecture](https://blog.cleancoder.com/uncle-bob/2012/08/13/the-clean-architecture.html).
|
||||
* The app is developed using the MVVM (Model View Viewmodel) pattern
|
||||
* Components are wired together using Dependency Injection (DI) with [Dagger 2](https://dagger.dev)
|
||||
|
@ -10,6 +14,11 @@
|
|||
|
||||
## Building
|
||||
|
||||
Since there are some [issues](https://stackoverflow.com/questions/61410231/android-studio-cannot-resolve-symbols-for-composite-includebuild-dependency-in-j)
|
||||
with Android Studio and [composite builds](https://docs.gradle.org/current/userguide/composite_builds.html),
|
||||
it is currently only possible to build Mercury-IM either using the Gradle command line tool (see below),
|
||||
or by using Android Studio 3.5.3.
|
||||
|
||||
```
|
||||
git clone <project-url>
|
||||
cd <project-directory>
|
||||
|
|
Loading…
Reference in a new issue