diff --git a/README.md b/README.md index 95bad69..e387227 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,102 @@ -# anidero -Render After Effects animations in JSON format on Android +# Anidero for Android + +## Intro +An Android Library that renders After Effects animations +in JSON format + +## Getting Started +For information on how to get started with Anidero, +take a look at our [Getting Started](docs/getting-started.md) guide. + +## Submitting Bugs or Feature Requests +Bugs or feature requests should be submitted at our [GitHub Issues section](https://github.com/zeoflow/anidero/issues). + +## How does it work? +### 1. Depend on our library + +Anidero for Android is available through Google's Maven Repository. +To use it: + +1. Open the `build.gradle` file for your application. +2. Make sure that the `repositories` section includes Google's Maven Repository + `google()`. For example: + + ```groovy + allprojects { + repositories { + google() + jcenter() + } + } + ``` + +3. Add the library to the `dependencies` section: + + ```groovy + dependencies { + // ... + implementation 'com.zeoflow:anidero:' + // ... + } + ``` + +### 2. Add a Anidero component to your app +`activity_main.xml` + +```xml + + + +``` + +### 3. Activity/Fragment Class +`MainActivity.java` + +```java +public class MainActivity extends BindAppActivity +{ + //.. + private AnideroView zAnideroView; + //.. + @Override + protected void onCreate(@Nullable Bundle savedInstanceState) + { + //.. + zAnideroView = findViewById(R.id.zAnideroView); + //.. + zAnideroView.setAnimation("animation.json"); + zAnideroView.playAnimation(); + zAnideroView.setSpeed(1f); + //.. + } + //.. +} +``` +###### `animation.json` is read from the \assets folder + +## License + Copyright 2020 ZeoFlow + + 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. ## 🏆 Contributors 🏆 diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..4e2075c --- /dev/null +++ b/docs/README.md @@ -0,0 +1,99 @@ +# Anidero for Android + +## Intro +An Android Library that renders After Effects animations +in JSON format + +## Getting Started +For information on how to get started with Anidero, +take a look at our [Getting Started](docs/getting-started.md) guide. + +## Submitting Bugs or Feature Requests +Bugs or feature requests should be submitted at our [GitHub Issues section](https://github.com/zeoflow/anidero/issues). + +## How does it work? +### 1. Depend on our library + +Anidero for Android is available through Google's Maven Repository. +To use it: + +1. Open the `build.gradle` file for your application. +2. Make sure that the `repositories` section includes Google's Maven Repository + `google()`. For example: + + ```groovy + allprojects { + repositories { + google() + jcenter() + } + } + ``` + +3. Add the library to the `dependencies` section: + + ```groovy + dependencies { + // ... + implementation 'com.zeoflow:anidero:' + // ... + } + ``` + +### 2. Add a Anidero component to your app +`activity_main.xml` + +```xml + + + +``` + +### 3. Activity/Fragment Class +`MainActivity.java` + +```java +public class MainActivity extends BindAppActivity +{ + //.. + private AnideroView zAnideroView; + //.. + @Override + protected void onCreate(@Nullable Bundle savedInstanceState) + { + //.. + zAnideroView = findViewById(R.id.zAnideroView); + //.. + zAnideroView.setAnimation("animation.json"); + zAnideroView.playAnimation(); + zAnideroView.setSpeed(1f); + //.. + } + //.. +} +``` +###### `animation.json` is read from the \assets folder + +## License + Copyright 2020 ZeoFlow + + 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. \ No newline at end of file diff --git a/docs/building-from-source.md b/docs/building-from-source.md new file mode 100644 index 0000000..9058eaa --- /dev/null +++ b/docs/building-from-source.md @@ -0,0 +1,20 @@ + + +# Building From the Latest Source + +If you'll be contributing to the library, or need a version newer than what has +been released, Anidero from ZeoFlow can also be built from source. +To do so: + +Clone the repository: + +```sh +git clone https://github.com/zeoflow/anidero.git +``` + +Then, build the library's AARs using Gradle \ No newline at end of file diff --git a/docs/contributing.md b/docs/contributing.md new file mode 100644 index 0000000..01c8caf --- /dev/null +++ b/docs/contributing.md @@ -0,0 +1,51 @@ + + +# General Contributing Guidelines + +The Anidero contributing policies and procedures can be found in the +main Anidero documentation repository’s +[contributing page](https://github.com/zeoflow/anidero/blob/CONTRIBUTING.md). + +To make a contribution, you'll need to be able to build the library from source +and run our tests. + +## Building From Source + +Take a look at our [instructions](building-from-source.md) on how to build the +library from source. + +## Running Tests + +Anidero for Android has JVM tests as well as Emulator tests. + +To run the JVM tests, do: + +```sh +./gradlew test +``` + +To run the emulator tests, ensure you have +[a virtual device set up](https://developer.android.com/studio/run/managing-avds.html) +and do: + +```sh +./gradlew connectedAndroidTest +``` + +## Code Conventions + +Since we all want to spend more time coding and less time fiddling with +whitespace, Anidero uses code conventions and styles to +encourage consistency. Code with a consistent style is easier (and less +error-prone!) to review, maintain, and understand. + +#### Be consistent + +If the style guide is not explicit about a particular situation, the cardinal +rule is to **be consistent**. For example, take a look at the surrounding code +and follow its lead, or look for similar cases elsewhere in the codebase. \ No newline at end of file diff --git a/docs/getting-started.md b/docs/getting-started.md new file mode 100644 index 0000000..4525bcc --- /dev/null +++ b/docs/getting-started.md @@ -0,0 +1,42 @@ + + +### 1. Depend on our library + +Anidero for Android is available through Google's Maven Repository. +To use it: + +1. Open the `build.gradle` file for your application. +2. Make sure that the `repositories` section includes Google's Maven Repository + `google()`. For example: + + ```groovy + allprojects { + repositories { + google() + jcenter() + } + } + ``` + +3. Add the library to the `dependencies` section: + + ```groovy + dependencies { + // ... + implementation 'com.zeoflow:anidero:' + // ... + } + ``` + +Visit [MVN Repository](https://mvnrepository.com/artifact/com.zeoflow/anidero) +to find the latest version of the library. + +## Contributors + +Anidero for Android welcomes contributions from the community. Check +out our [contributing guidelines](contributing.md) before getting started.