Add some docs - lots of outdated part.
This commit is contained in:
21
README.md
21
README.md
@@ -10,7 +10,6 @@ The application is a total rewrite of [Element-Android](https://github.com/vecto
|
||||
* [Roadmap](#roadmap)
|
||||
* [Contributing](#contributing)
|
||||
* [Build instructions](#build-instructions)
|
||||
* [Modules](#modules)
|
||||
* [Support](#support)
|
||||
* [Copyright & License](#copyright-&-license)
|
||||
|
||||
@@ -36,26 +35,6 @@ Come chat with the community in the dedicated Matrix [room](https://matrix.to/#/
|
||||
|
||||
Just clone the project and open it in Android Studio.
|
||||
|
||||
## Modules
|
||||
|
||||
This Android project is a multi modules project.
|
||||
|
||||
- `app` module is the Android application module. Other modules are libraries;
|
||||
- `features` modules contain some UI and can be seen as screen of the application;
|
||||
- `libraries` modules contain classes that can be useful for other modules to work.
|
||||
|
||||
A few details about some modules:
|
||||
|
||||
- `libraries-core` module contains utility classes;
|
||||
- `libraries-designsystem` module contains Composables which can be used across the app (theme, etc.);
|
||||
- `libraries-elementresources` module contains resource from Element Android (mainly strings);
|
||||
- `libraries-matrix` module contains wrappers around the Matrix Rust SDK.
|
||||
|
||||
Here is the current module dependency graph:
|
||||
|
||||
<!-- To update this graph, run `./tools/docs/generateModuleGraph.sh` (one day the CI will do it hopefully). -->
|
||||
<img src=./docs/images/module_graph.png width=800 />
|
||||
|
||||
## Support
|
||||
|
||||
When you are experiencing an issue on ElementX Android, please first search in [GitHub issues](https://github.com/vector-im/element-x-android/issues)
|
||||
|
||||
Reference in New Issue
Block a user