Updated README
This commit is contained in:
parent
0c6f000da7
commit
d55561878f
1 changed files with 21 additions and 25 deletions
32
README.md
32
README.md
|
@ -6,7 +6,7 @@ Linphone is an open source softphone for voice and video over IP calling and ins
|
||||||
|
|
||||||
It is fully SIP-based, for all calling, presence and IM features.
|
It is fully SIP-based, for all calling, presence and IM features.
|
||||||
|
|
||||||
General description is available from [linphone web site](https://www.linphone.org/technical-corner/linphone)
|
General description is available from [linphone web site](https://www.linphone.org/technical-corner/linphone).
|
||||||
|
|
||||||
### License
|
### License
|
||||||
|
|
||||||
|
@ -24,16 +24,20 @@ Linphone is dual licensed, and is available either :
|
||||||
|
|
||||||
- Linphone public wiki : https://wiki.linphone.org/xwiki/wiki/public/view/Linphone/
|
- Linphone public wiki : https://wiki.linphone.org/xwiki/wiki/public/view/Linphone/
|
||||||
|
|
||||||
|
- Tutorials : https://gitlab.linphone.org/BC/public/tutorials/-/tree/master/android/kotlin
|
||||||
|
|
||||||
# What's new
|
# What's new
|
||||||
|
|
||||||
Now the default way of building linphone-android is to download the AAR SDK in our maven repository.
|
App has been totally rewritten in Kotlin using modern components such as Navigation, Data Binding, View Models, coroutines, etc...
|
||||||
Compared to previous versions, this project no longer uses submodules developper has to build in order to get a working app.
|
Check the [CHANGELOG](./CHANGELOG.md) file for a more detailled list.
|
||||||
However, if you wish to use a locally compiled SDK see below how to proceed.
|
The first linphone-android release that will be based on this will be 4.5.0, using 5.0.0 SDK.
|
||||||
|
|
||||||
We offer different flavors for the SDK in our maven repository: org.linphone.no-video (a build without video) and org.linphone.legacy (old java wrapper if you didn't migrate your app code to the new one yet).
|
We're also taking a fresh start regarding translations so less languages will be available for a while.
|
||||||
|
If you want to contribute, you are welcome to do so, check the [Translations](#Translations) section below.
|
||||||
|
|
||||||
The repository structure has also been cleaned and updated, and changing the package name can now be done in a single step.
|
org.linphone.legacy flavor (old java wrapper if you didn't migrate your app code to the new one yet) is no longer supported starting 5.0.0 SDK.
|
||||||
This allows developpers to keep a stable version as well as a developpment one on the same device easily.
|
|
||||||
|
The sample project has been removed, we now recommend you to take a look at our [tutorials](https://gitlab.linphone.org/BC/public/tutorials/-/tree/master/android/kotlin).
|
||||||
|
|
||||||
# Building the app
|
# Building the app
|
||||||
|
|
||||||
|
@ -95,7 +99,7 @@ Also check you have built the SDK for the right CPU architecture using the `-DLI
|
||||||
|
|
||||||
## Troubleshouting
|
## Troubleshouting
|
||||||
|
|
||||||
When submitting an issue on our [Github repository](https://github.com/BelledonneCommunications/linphone-android), please attach the matching library logs:
|
When submitting an issue on our [Github repository](https://github.com/BelledonneCommunications/linphone-android), please follow the template and attach the matching library logs:
|
||||||
|
|
||||||
1. To enable them, go to Settings -> Advanced and toggle `Debug Mode`. If they are already enabled, clear them first using the `Reset logs` button on the About page.
|
1. To enable them, go to Settings -> Advanced and toggle `Debug Mode`. If they are already enabled, clear them first using the `Reset logs` button on the About page.
|
||||||
|
|
||||||
|
@ -124,17 +128,9 @@ If you have your own push server, replace this file by yours.
|
||||||
|
|
||||||
## Translations
|
## Translations
|
||||||
|
|
||||||
We use transifex so the community can translate the strings of the app in their own language.
|
We no longer use transifex for the translation process, instead we have deployed our own instance of [Weblate](https://weblate.linphone.org/).
|
||||||
|
|
||||||
Note for developpers: here's how to push/pull string resources to/from transifex:
|
Inscriptions are currently disabled but you can [contact us](https://weblate.linphone.org/contact/) to request an access if you want to contribute.
|
||||||
```
|
|
||||||
tx pull -af
|
|
||||||
```
|
|
||||||
to update local translations with latest transifex changes
|
|
||||||
```
|
|
||||||
tx push -s -f --no-interactive
|
|
||||||
```
|
|
||||||
to push new strings to transifex so they can be translated.
|
|
||||||
|
|
||||||
# CONTRIBUTIONS
|
# CONTRIBUTIONS
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue