From 74b1fa26abadd89c20544bf743e00abd5feb855d Mon Sep 17 00:00:00 2001 From: Michell Bak Date: Thu, 20 Nov 2014 01:29:08 +0100 Subject: [PATCH] Final steps in transitioning to Android Studio --- CONTRIBUTING.md | 44 ++++ LICENSE.txt | 202 ++++++++++++++++++ README.md | 51 +++++ TRANSLATING.md.txt | 54 +++++ app/app.iml | 2 +- app/libs/okhttp-2.0.0.jar | Bin 260956 -> 0 bytes app/libs/okhttp-urlconnection-2.0.0.jar | Bin 30764 -> 0 bytes app/libs/okio-1.0.1.jar | Bin 52794 -> 0 bytes app/libs/otto-1.3.4.jar | Bin 19025 -> 0 bytes app/libs/picasso-2.3.4.jar | Bin 102925 -> 0 bytes app/src/main/AndroidManifest.xml | 4 +- .../main/java/com/miz/mizuu/FileSources.java | 1 + extras/mizuu_logo_material.psd | Bin 0 -> 366162 bytes 13 files changed, 355 insertions(+), 3 deletions(-) create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE.txt create mode 100644 README.md create mode 100644 TRANSLATING.md.txt delete mode 100644 app/libs/okhttp-2.0.0.jar delete mode 100644 app/libs/okhttp-urlconnection-2.0.0.jar delete mode 100644 app/libs/okio-1.0.1.jar delete mode 100644 app/libs/otto-1.3.4.jar delete mode 100644 app/libs/picasso-2.3.4.jar create mode 100644 extras/mizuu_logo_material.psd diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..4b5bef88 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,44 @@ +Contributing to Mizuu's development +============ + +#### Contributing code? + +1. [Fork Mizuu][1]. +2. `git checkout -b descriptive-branch-name dev` and make your commits. +3. When you think your code is ready, start a pull request against the dev branch. Please reference [existing issues][2] when possible. + +#### No code? +* You can [suggest features][2]. +* You can [discuss a bug][2] or [report a bug][2]! +* You can [translate strings][3]. + +Branch structure +---------------- + +The repository is made up of two main branches: master (stable) and dev (unstable / work in progress). + +* **master** has the latest stable code, its tags are released as versions of Mizuu on GitHub, www.mizuu.tv and Google Play. +* **dev** includes the latest unstable code from contributers (you!). + +Since Mizuu was just recently open-sourced, there's still some work to do with branching and the overall structure of the development, but this is on the to-do list. For now, use the tagged commits as release versions. + +Setup +----- + +Mizuu is developed using Android Studio and is built with Java 1.7. + +In order to use the project with the various web services, you'll need to add an `api_keys.xml` file to `/res/values/` with the following content: + +```xml + + + add_your_own + add_your_own + add_your_own + add_your_own + +``` + + [1]: https://github.com/MizzleDK/Mizuu/fork + [2]: https://github.com/MizzleDK/Mizuu/issues + [3]: http://translate.mizuu.tv/ diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 00000000..d6456956 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. diff --git a/README.md b/README.md new file mode 100644 index 00000000..b95d02d6 --- /dev/null +++ b/README.md @@ -0,0 +1,51 @@ +Mizuu - media indexer for Android +===== + +This GitHub repository houses the source code of the Mizuu application for Android. + +![image alt][1] + +Description +---------------------- + +Mizuu is a user friendly media center application for Android tablets and smartphones running Android 4.0.3 (API level 15) or newer. The application helps manage all your movie and TV show video files - and automatically fetches useful information about the video content, including title, plot, cover art and actors. + +Features +- Indexing of movie and TV show files on your device or on Samba (CIFS / SMB) and UPnP / DLNA compatible devices +- View actor details for movies, including biography, filmography and photos +- Many options to customize and personalize the application +- Enjoy popular video content from YouTube, Reddit as well as the latest TED Talks +- Browse details and watch trailers for upcoming and popular movies with online search +- Different widgets for displaying your collections on the home screen +- Synchronizes indexed content with your Trakt.tv account + + +Dependencies +------------ + +Mizuu uses a number of third-party libraries, which are all included as dependencies or as .jar files in the /app/libs/ folder of this repo. + +Contributing +------------ + +If you want to contribute to Mizuu's development, there's plenty of ways to do it. You can read about it in [CONTRIBUTING.md][2]. + +License +------- + + Copyright 2014 Michell Bak + + 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. + + [1]: http://i.imgur.com/0SyCwrG.jpg + [2]: https://github.com/MizzleDK/Mizuu/blob/master/CONTRIBUTING.md diff --git a/TRANSLATING.md.txt b/TRANSLATING.md.txt new file mode 100644 index 00000000..a0f4a4d3 --- /dev/null +++ b/TRANSLATING.md.txt @@ -0,0 +1,54 @@ +Translating Mizuu +============ + +#### Steps + +1. [Fork Mizuu][1]. +2. Read the guidelines on how to translate strings below. +3. `git checkout -b branch-name-language dev` and commit your translations. +4. When you think your translations are done, start a pull request against the dev branch. + +#### How to translate + +1. Locate the original strings in [/res/values/strings.xml][2] +2. Check if the strings have already been translated into the language you want to translate to. You can do that by checking [/res/][3] folder and look for values-##, where ## represents the [ISO 639-1 code][4] of the language, i.e. `values-da` for Danish. +3. If the language folder exists, you can check previous translations and add missing ones. If the folder doesn't exist, you can create it and add translations. +4. See the section below for specific translation examples + +Examples of string translation +============ + +#### Regular strings + +`Movies` + +*... gets translated into this (for Danish):* + +`Film` + +Some strings have explanations / context descriptions. Please refer to these, if you have any questions or doubts, or alternatively contact me or mention it in the pull request. + +#### Plural strings + +```xml + + movie + movies + +``` + +*... gets translated into this (for Danish):* + +```xml + + film + film + +``` + +Some languages include words for many different quantities. You may add or remove these quantities to match the specific language. Valid quantities are: "zero", "one", "two", "few", "many", "other". + + [1]: https://github.com/MizzleDK/Mizuu/fork + [2]: https://github.com/MizzleDK/Mizuu/blob/master/res/values/strings.xml + [3]: https://github.com/MizzleDK/Mizuu/blob/master/res/ + [4]: http://www.loc.gov/standards/iso639-2/php/code_list.php diff --git a/app/app.iml b/app/app.iml index af2bffdf..c3c2ff82 100644 --- a/app/app.iml +++ b/app/app.iml @@ -17,7 +17,7 @@