Contributing Code

The Tecla Next project is made up of various components derived from separate sources. All of the components of the project must be retrieved and set-up in order to prepare the project for development. These components are:

• The [Tecla Next Framework] (https://github.com/idrc/tecla-framework), which in turn requires the following library:
  • The [Tecla SDK] (https://github.com/idrc/tecla-sdk), and
• The [Tecla Next Latin IME] (https://github.com/idrc/tecla-LatinIME), which has the following dependency:
  • The Input Method Common code (from https://android.googlesource.com/platform/frameworks/opt/inputmethodcommon @jb-release)

The Tecla Next Framework (https://github.com/idrc/tecla-framework) is the main development target. In contrast, the [Tecla Next Latin IME] (https://github.com/idrc/tecla-LatinIME), which tracks the Android built-in input method, will be used exclusively for application release and will only take mods that have the sole purpose of integrating the functionality of The Tecla Next Framework (https://github.com/idrc/tecla-framework).

1. Fork & Clone

Start by forking and cloning all the required components. These are as follows:

• [Tecla Next Framework] (https://github.com/idrc/tecla-framework)
• [Tecla SDK] (https://github.com/idrc/tecla-sdk)
• [Tecla Next Latin IME] (https://github.com/idrc/tecla-LatinIME)
• Input Method Common code
• InputAccessLib

2. Set-up development environment

It is highly recommended that new developers use Linux to set up their development environment for Tecla Next. Note that, although it is possible to use other operating systems, our team will be unable to provide meaningful advice and/or support to developers wishing to develop in an OS other than Linux.

Development on the Tecla Next Framework requires the Android SDK installed on the Eclipse IDE.

Android SDK on Eclipse

1. Download and set up the Android SDK following the instructions here

On Linux (Eclipse)

1. Import the [Tecla SDK] (https://github.com/idrc/tecla-sdk) into Eclipse and set it up as a library
2. Import the [Tecla Next Framework] (https://github.com/idrc/tecla-framework) into Eclipse and set it up as a library
3. Add the [Tecla SDK] (https://github.com/idrc/tecla-sdk) as a library to the [Tecla Next Framework] (https://github.com/idrc/tecla-framework).
4. Create a symlink inside the com/android/ folder (within the Tecla Next Latin IME) that points to the com/android/inputmethodcommon folder (from the Input Method Common code).
5. Create a symlink inside the com/android/ folder (within the Tecla Next Latin IME) that points to the addon/tecla folder (from the Tecla Next Framwork code).
6. Create a symlink inside the java/ folder (within the Tecla Next Latin IME) that points to the native/jni folder (from the Tecla Next Latin IME code)
7. Import the [Tecla Next Latin IME] (https://github.com/idrc/tecla-LatinIME) into Eclipse
8. Add the [Tecla Next Framework] (https://github.com/idrc/tecla-framework) as a library to the [Tecla Next Latin IME] (https://github.com/idrc/tecla-LatinIME).
9. Import the [InputAccessLib] (https://github.com/idrc/InputAccessLib) into Eclipse
10. Add the [InputAccessLib] (https://github.com/idrc/InputAccessLib) as a library to the [Tecla Next Latin IME] (https://github.com/idrc/tecla-LatinIME).
11. Build the Android app as usual

On Windows (Eclipse)

Development set-up instructions for Windows are not officially maintained. A [likely outdated version of these instructions] (https://github.com/idrc/tecla-framework/wiki/Windows-Development-Environment) is available [here] (https://github.com/idrc/tecla-framework/wiki/Windows-Development-Environment). Please use these instructions with care and, when in doubt, refer back to the Linux instructions above.

Setting up NDK Compiler

1. Download the NDK here
2. Set up the NDK compiler to the [Tecla Next Latin IME] (http://mobilepearls.com/labs/ndk-builder-in-eclipse/) project following the instructions here