diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..fe1f5883 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,34 @@ +# How to become a contributor and submit your own code + +## Contributor License Agreements + +We'd love to accept your sample apps and patches! Before we can take them, we +have to jump a couple of legal hurdles. + +Please fill out either the individual or corporate Contributor License Agreement (CLA). + + * If you are an individual writing original source code and you're sure you + own the intellectual property, then you'll need to sign an [individual CLA] + (https://cla.developers.google.com). + * If you work for a company that wants to allow you to contribute your work, + then you'll need to sign a [corporate CLA] + (https://cla.developers.google.com). + +Follow either of the two links above to access the appropriate CLA and +instructions for how to sign and return it. Once we receive it, we'll be able to +accept your pull requests. + +## Contributing A Patch + +1. Submit an issue describing your proposed change to the repo in question. +1. The repo owner will respond to your issue promptly. +1. If your proposed change is accepted, and you haven't already done so, sign a + Contributor License Agreement (see details above). +1. Fork the desired repo, develop and test your code changes. +1. Ensure that your code adheres to the existing style in the sample to which + you are contributing. Refer to the + [Android Code Style Guide] + (https://source.android.com/source/code-style.html) for the + recommended coding standards for this organization. +1. Ensure that your code has an appropriate set of unit tests which all pass. +1. Submit a pull request. diff --git a/README.md b/README.md index 26d45206..7fb34fb8 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,52 @@ -# CameraView # +# CameraView -CameraView +*This is a preview release. The API is subject to change.* + +This is not an official Google product. + +CameraView aims to help Android developers easily integrate Camera features. + +Requires API Level 14. The library uses Camera 1 API on API Level 14-20 and Camera2 on 21 and above. + +## Features + +- Camera preview by placing it in a layout XML (and calling the start method) +- Configuration by attributes + - Aspect ratio (app:aspectRatio) + - Auto-focus (app:autoFocus) + - Flash (app:flash) + +## Usage + +```xml + +``` + +```java + @Override + protected void onResume() { + super.onResume(); + mCameraView.start(); + } + + @Override + protected void onPause() { + mCameraView.stop(); + super.onPause(); + } +``` + +You can see a complete usage in the demo app. + +## Contribution + +See [CONTRIBUTING.md](/CONTRIBUTING.md). diff --git a/demo/proguard-rules.pro b/demo/proguard-rules.pro deleted file mode 100644 index 4e059bf9..00000000 --- a/demo/proguard-rules.pro +++ /dev/null @@ -1,17 +0,0 @@ -# Add project specific ProGuard rules here. -# By default, the flags in this file are appended to flags specified -# in /usr/local/google/home/yaraki/opt/android-sdk/tools/proguard/proguard-android.txt -# You can edit the include path and order by changing the proguardFiles -# directive in build.gradle. -# -# For more details, see -# http://developer.android.com/guide/developing/tools/proguard.html - -# Add any project specific keep options here: - -# If your project uses WebView with JS, uncomment the following -# and specify the fully qualified class name to the JavaScript interface -# class: -#-keepclassmembers class fqcn.of.javascript.interface.for.webview { -# public *; -#} diff --git a/library/proguard-rules.pro b/library/proguard-rules.pro deleted file mode 100644 index 4e059bf9..00000000 --- a/library/proguard-rules.pro +++ /dev/null @@ -1,17 +0,0 @@ -# Add project specific ProGuard rules here. -# By default, the flags in this file are appended to flags specified -# in /usr/local/google/home/yaraki/opt/android-sdk/tools/proguard/proguard-android.txt -# You can edit the include path and order by changing the proguardFiles -# directive in build.gradle. -# -# For more details, see -# http://developer.android.com/guide/developing/tools/proguard.html - -# Add any project specific keep options here: - -# If your project uses WebView with JS, uncomment the following -# and specify the fully qualified class name to the JavaScript interface -# class: -#-keepclassmembers class fqcn.of.javascript.interface.for.webview { -# public *; -#}