Classy Tools

Android is optional

Classy Tools is foremost a Java package with Android support an optional extra which requires Android-specific development components and tooling. The initial steps below are general after which instructions break into separate Java-only and Android development branches.

Step 1 - Get software development tools ready

All projects are currently built with Maven. The Java Tools table on the right includes Maven and has links to download sites. If you have just installed Maven, check it will run from the command line by entering the command "mvn --version" and check for the expected version (3.3.9 or above). eg.

$ mvn --version
Apache Maven 3.3.9 ...
Maven home: /usr/local/apache-maven-3.3.9
...

Of course a Java SDK must also be installed on your PC.

Step 2 - Download Classy Tools modules to your PC

The Classy Tools project is cloned from a Github repository. In a command console, go to your chosen workspace location and run:

git clone https://github.com/andrew-bowley/classy_tools

Upon completion, the project will be found in the "classy_tools" sub directory, from now referred to as the Classy Tools "home location".

If proceeding with Java-only development, then go to Java development without Android

Step 3 - Install Android SDK

If you don't have an up-to-date Android SDK, then the easiest way to get it is to install Android Studio. Go to the Android Studio page and click on the prominent "Download Android Studio" button to download the correct version for the platform you are using. On first time execution, Android Studio sets up the SDK and ensures your JDK is valid. Note that is is worthwhile to select the custom install option to select UI theme and see what platform version will be installed.

Java Tools

Tool Description
git Git is a free and open source distributed version control system.
maven Apache Maven is a software project management and comprehension tool. Recommended version 3.3.9 and above
eclipse Java developer tool, including a Java IDE, Git client and Maven integration. Recommended: Eclipse Neon - IDE for Java/Android Developers.

You will also need to install additional SDK components - "Android 7.0 (API24)" and "Android SDK Build Tools 25.0.1". To find out how to do this from Android Studio, go to Update Your Tools with the SDK Manager. You can also run the SDK Manager from the command line running android (android.bat on Windows) which is located in the "tools" folder of the Android SDK installation.

Note you can update the Build Tools version to the one installed by Android Studio by updating the build.gradle "buildToolsVersion" value in each module of the the project.

Android Home Environment Variable

If you have not already done so, set up the environment variable ANDROID_HOME to contain the absolute folder where the SDK is installed (e.g. under bash: export ANDROID_HOME=/opt/android_sdk_linux) and ensure that the folder for ANDROID_HOME and all files within are readable by the current user.