Skip to content

Commit

Permalink
initial version for Droided Media Tank open source release
Browse files Browse the repository at this point in the history
  • Loading branch information
vikingbrain committed Oct 12, 2014
1 parent cd35d4c commit f5a9eeb
Show file tree
Hide file tree
Showing 585 changed files with 25,829 additions and 0 deletions.
69 changes: 69 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,69 @@
# Contributing to Droided Media Tank for Android

Looking to contribute something to the DroidedMediaTank? Here's how you can help.

## Bugs reports

A bug is a _demonstrable problem_ that is caused by the code in the
repository. Good bug reports are extremely helpful - thank you!

Guidelines for bug reports:

1. **Use the GitHub issue search** — check if the issue has already been
reported.

2. **Check if the issue has been fixed** — try to reproduce it using the
latest `master` or development branch in the repository.

3. **Isolate the problem** — ideally create a reduced test
case and a live example.

4. Please try to be as detailed as possible in your report. Include specific
information about the environment - operating system and version, browser
and version, version of DroidedMediaTank - and steps required to reproduce the issue.


## Feature requests & contribution enquiries

Feature requests are welcome. But take a moment to find out whether your idea
fits with the scope and aims of the project. It's up to *you* to make a strong
case for the inclusion of your feature. Please provide as much detail and
context as possible.

Contribution enquiries should take place before any significant pull request,
otherwise you risk spending a lot of time working on something that we might
have good reasons for rejecting.


## Pull requests

Good pull requests - patches, improvements, new features - are a fantastic
help. They should remain focused in scope and avoid containing unrelated
commits.

Make sure to adhere to the coding conventions used throughout the codebase
(indentation, accurate comments, etc.) and any other requirements (such as test
coverage).

Please follow this process; it's the best way to get your work included in the
project:

1. Create a new topic branch to contain your feature, change, or fix:

2. Commit your changes in logical chunks. Provide clear and explanatory commit
messages. Use git's [interactive rebase](https://help.github.com/articles/interactive-rebase)
feature to tidy up your commits before making them public.

3. Locally merge (or rebase) the upstream development branch into your topic branch:

4. Push your topic branch up to your fork:

5. [Open a Pull Request](http://help.github.com/send-pull-requests/) with a
clear title and description.

## License

By contributing your code,

You agree to license your contribution under the terms of the Apache Public License 2.0
https://github.com/vikingbrain/droidedmediatank/blob/master/LICENSE.md
97 changes: 97 additions & 0 deletions README.md
@@ -0,0 +1,97 @@
# Droided Media Tank for Android [![Google Play](http://developer.android.com/images/brand/en_generic_rgb_wo_45.png)](https://play.google.com/store/apps/details?id=com.vikingbrain.dmt) [<img src="http://static.vikingbrain.com/dmt/images/apk.png" height="45px" />](http://static.vikingbrain.com/dmt/releases/)
[![Flattr donate button](http://img.shields.io/flattr/donate.png?color=blue)](https://flattr.com/profile/vikingbrain "Donate monthly to this project using Flattr")
[![PayPal donate button](http://img.shields.io/paypal/donate.png?color=blue)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=9UAHFFF7B2BLG "Donate once-off to this project using Paypal")

Droided Media Tank is an Android application that allows remote control and management of Networked Media Tank media streamers. Designed for Popcorn Hour A100, A110, A200, A210, A300, A400, B110, C200, C300, PopBox 3D, PopBox V8, eGreat, Digitek HDX, Kaiboer and others based in NMT system.

![Dashboard](http://static.vikingbrain.com/dmt/screenshots/screenshot_2.10_1.png)
![Remote control](http://static.vikingbrain.com/dmt/screenshots/screenshot_2.9_6.png)
![File browser](http://static.vikingbrain.com/dmt/screenshots/screenshot_2.9_4.png)
![NMT services](http://static.vikingbrain.com/dmt/screenshots/screenshot_2.9_8.png)

## Requirements

java 1.6+, Android 2.1+

## Building and installing

The build requires [Maven](http://maven.apache.org/download.html)
v3.1.1+ and the [Android SDK](http://developer.android.com/sdk/index.html)
to be installed in your development environment. In addition you'll need to set
the `ANDROID_HOME` environment variable to the location of your SDK:

```bash
export ANDROID_HOME=/opt/tools/android-sdk
```

## Compiling

* Run `mvn clean install` from the `root` directory to build the APK

## Running

* Start an Android emulator manually or with `mvn android:emulator-start`
* Deploy and run the app in the emulator with `mvn android:deploy android:run`

## Debugging
* Use `mvn android:deploy android:run -Dandroid.run.debug=true`
* Start debugging connecting to remote java application [Debugging an Android app built with Maven](https://code.google.com/p/maven-android-plugin/wiki/Debug)

## More maven
* Type `mvn android:help` to find other useful commands from the `maven-android-plugin`

## Problems?

If you find any issues please [report them](https://github.com/vikingbrain/droidedmediatank/issues) or better,
send a [pull request](https://github.com/vikingbrain/droidedmediatank/pulls).

## Author:
* Rafael Iñigo (vikingBrain)

## Libraries and resources used in the project

* [TheDavidBox client for Java](https://www.github.com/vikingbrain/thedavidbox-client4j), a Java HTTP client for consuming TheDavidBox Service API of Networked Media Tank devices.
Apache License, Version 2.0
* [ActionBarSherlock](https://github.com/JakeWharton/ActionBarSherlock), an extension of the support library designed to facilitate the use of the action bar design pattern across all versions of Android with a single API.
Apache License 2.0
* [OI File Manager](https://github.com/openintents/filemanager), an Android file manager.
Apache License, Version 2.0
* [EdtFTPj/Free](http://enterprisedt.com/products/edtftpj/), an open source FTP client library for use in Java applications licensed under the LGPL.
* [AChartEngine](http://www.achartengine.org), a charting software library for Android applications.
Apache License 2.0
* [c200remote project](http://code.google.com/p/c200remote/), web remote control for Popcorn Hour A/C-200 released under the New BSD License, original images has been made by SmashD.

## License

Copyright (c) 2014 Rafael Iñigo

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Other licenses reference:

This application reuses sources from the [c200remote project](http://code.google.com/p/c200remote/) released under the New BSD License:

Copyright (c) 2009, Daniel Cervera, dc11ab+c200remote@gmail.com
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

## Disclaimer third parties

All product and company names are trademarks™ or registered® trademarks of their respective holders. Use of them does not imply any affiliation with or endorsement by them.
All specifications are subject to change without notice.
Popcorn Hour, Popbox, Networked Media Tank and SayaTv are trademarks of Syabas Technology Inc., Registered in the U.S.

0 comments on commit f5a9eeb

Please sign in to comment.