ensichat/README.md

Ensichat
========

Instant messenger for Android that is fully decentralized. Messages are encrypted and sent directly
between devices via Bluetooth or Internet, without any central server. A simple flood-based routing
is used for message propagation.

<img src="graphics/screenshot_phone_1.png" alt="screenshot 1" width="200" />
<img src="graphics/screenshot_phone_2.png" alt="screenshot 2" width="200" />
<img src="graphics/screenshot_phone_3.png" alt="screenshot 3" width="200" />

[![Get it on Google Play](https://developer.android.com/images/brand/en_generic_rgb_wo_60.png)](https://play.google.com/store/apps/details?id=com.nutomic.ensichat) [![Get it on F-Droid](https://f-droid.org/wiki/images/0/06/F-Droid-button_get-it-on.png)](https://f-droid.org/repository/browse/?fdid=com.nutomic.ensichat)

Building
--------

To setup a development environment, just install [Android Studio](https://developer.android.com/sdk/)
and import the project.

Alternatively, you can use the command line. To create a debug apk, run `./gradlew assembleDevDebug`.
This requires at least Android Lollipop on your development device. If you don't have 5.0 or higher,
you have to use `./gradlew assembleRelDebug`. However, this results in considerably slower
incremental builds. To create a release apk, run `./gradlew assembleRelRelease`.

Testing
-------

You can run the unit tests with `./gradlew test`. After connecting an Android device, you can run
the Android tests with `./gradlew connectedDevDebugAndroidTest` (or
`./gradlew connectedRelDebugAndroidTest` if your Android version is  lower than 5.0).

To run integration tests for the core module, use `./gradlew integration:run`. If this fails (or
is very slow), try changing the value of Crypto#PublicKeySize to 512 (in the core module).

License
-------

All code is licensed under the [GPL](LICENSE), v3 or later.

The launcher icon is based on the [Bubbles Icon](https://www.iconfinder.com/icons/285667/bubbles_icon) created by [Paomedia](https://www.iconfinder.com/paomedia) which is available under [CC BY 3.0](http://creativecommons.org/licenses/by/3.0/).
Fixed app name higher/lower case. 2015-06-24 14:20:30 +00:00			`Ensichat`
Added build instructions. 2014-10-03 10:08:08 +00:00			`========`
Updated readme. 2015-02-09 20:49:51 +00:00
Improved readme. - removed donate link for now - mention internet transport - suggest Android Studio for building 2016-04-26 10:27:11 +00:00			`Instant messenger for Android that is fully decentralized. Messages are encrypted and sent directly`
			`between devices via Bluetooth or Internet, without any central server. A simple flood-based routing`
			`is used for message propagation.`
Updated readme. 2015-02-09 20:49:51 +00:00
			`<img src="graphics/screenshot_phone_1.png" alt="screenshot 1" width="200" />`
			`<img src="graphics/screenshot_phone_2.png" alt="screenshot 2" width="200" />`
			`<img src="graphics/screenshot_phone_3.png" alt="screenshot 3" width="200" />`

Added Google Play and F-Droid badges. 2015-02-11 14:03:44 +00:00			`[![Get it on Google Play](https://developer.android.com/images/brand/en_generic_rgb_wo_60.png)](https://play.google.com/store/apps/details?id=com.nutomic.ensichat) [![Get it on F-Droid](https://f-droid.org/wiki/images/0/06/F-Droid-button_get-it-on.png)](https://f-droid.org/repository/browse/?fdid=com.nutomic.ensichat)`

Updated readme. 2015-02-09 20:49:51 +00:00			`Building`
			`--------`

Improved readme. - removed donate link for now - mention internet transport - suggest Android Studio for building 2016-04-26 10:27:11 +00:00			`To setup a development environment, just install [Android Studio](https://developer.android.com/sdk/)`
			`and import the project.`
Create "thin" build type and clean up previous commit. The "thin" build type relies on system scala library, while "debug" and "release" provide the library itself. 2014-12-02 17:01:32 +00:00
Improved readme. - removed donate link for now - mention internet transport - suggest Android Studio for building 2016-04-26 10:27:11 +00:00			Alternatively, you can use the command line. To create a debug apk, run `./gradlew assembleDevDebug`.
Implemented AODVv2, including integration test (fixes #33). For documentation on how AODVv2 works, see this link: https://datatracker.ietf.org/doc/draft-ietf-manet-aodvv2/ Note that this implementation is incompatible with AODVv2 itself, as various details are changed, and not all features have been implemented 2016-04-07 11:54:36 +00:00			`This requires at least Android Lollipop on your development device. If you don't have 5.0 or higher,`
			you have to use `./gradlew assembleRelDebug`. However, this results in considerably slower
Improved readme. - removed donate link for now - mention internet transport - suggest Android Studio for building 2016-04-26 10:27:11 +00:00			incremental builds. To create a release apk, run `./gradlew assembleRelRelease`.
Added build instructions. 2014-10-03 10:08:08 +00:00
Implemented AODVv2, including integration test (fixes #33). For documentation on how AODVv2 works, see this link: https://datatracker.ietf.org/doc/draft-ietf-manet-aodvv2/ Note that this implementation is incompatible with AODVv2 itself, as various details are changed, and not all features have been implemented 2016-04-07 11:54:36 +00:00			`Testing`
			`-------`

			You can run the unit tests with `./gradlew test`. After connecting an Android device, you can run
			the Android tests with `./gradlew connectedDevDebugAndroidTest` (or
			`./gradlew connectedRelDebugAndroidTest` if your Android version is lower than 5.0).

			To run integration tests for the core module, use `./gradlew integration:run`. If this fails (or
			`is very slow), try changing the value of Crypto#PublicKeySize to 512 (in the core module).`

Added license information. 2014-10-03 10:05:28 +00:00			`License`
Updated readme. 2015-02-09 20:49:51 +00:00			`-------`
Added license information. 2014-10-03 10:05:28 +00:00
			`All code is licensed under the [GPL](LICENSE), v3 or later.`
Added launcher icon (fixes #2). 2015-09-24 13:29:40 +00:00
Updated license text for launcher icon (ref #2). 2015-09-27 14:28:57 +00:00			`The launcher icon is based on the [Bubbles Icon](https://www.iconfinder.com/icons/285667/bubbles_icon) created by [Paomedia](https://www.iconfinder.com/paomedia) which is available under [CC BY 3.0](http://creativecommons.org/licenses/by/3.0/).`