Browse Source

Update readme.

concurrent-decode
Andrew Comminos 6 years ago
parent
commit
65968fd002
1 changed files with 10 additions and 14 deletions
  1. +10
    -14
      README.md

+ 10
- 14
README.md View File

@@ -1,25 +1,21 @@
Jumble
======

An Android service implementation of the Mumble protocol, designed to be used as the backend of Plumble in future releases.
An Android service implementation of the Mumble protocol, designed as the backend of [Plumble](https://www.github.com/Morlunk/Plumble).

Note that this project will only provide a service and utilities necessary for operation, and will never be a standalone app. That's what Plumble will be for.

Why?
About
-----

There's no open-source (free as in freedom) Mumble protocol implementation on Android. Jumble will serve to fill this void and aid in bringing a full-featured Mumble client to Android under the Apache License v2.

Due to the restrictive nature of the 'mumble-android' project by @pcgod, no sources or derivatives will be copied from that project.
The primary goal of the Jumble project is to encourage developers to embrace the Mumble protocol on Android through a free, complete, and stable implementation. At the moment, development is focused on improving stability and security.

The primary goal of the Jumble project is to replicate the functionality of the desktop Mumble client as much as possible. At the moment, development is focused on adding complete support for the Mumble protocol, particularly audio support (adding Speex and CELT alpha).
Prior to the release of Jumble, all implementations of the Mumble protocol on Android have been using the same non-free code developed by @pcgod. To ensure the unencumbered use of Jumble, no sources or derivatives will be copied from that project.

When?
-----
Projects using Jumble
---------------------

Jumble should be usable soon™. Likely by the end of summer 2013.
[Plumble 3.0+](https://www.github.com/Morlunk/Plumble)

How will I be able to use this?
-----
Including in your project
-------------------------

Upon release, Jumble will be usable as an Android library project. You'll be able to interface with the service via AIDL.
Jumble is a standard Android library project using the gradle build system. [See here for instructions on how to include it into your gradle project](http://tools.android.com/tech-docs/new-build-system/user-guide#TOC-Referencing-a-Library).

Loading…
Cancel
Save