Skip to content

Latest commit

 

History

History
74 lines (49 loc) · 2.6 KB

BUILDING.md

File metadata and controls

74 lines (49 loc) · 2.6 KB
Raw

Building Silence

Basics

Silence uses Gradle to build the project and to maintain dependencies.

Building Silence

The following steps should help you (re)build Silence from the command line.

  1. Checkout the source somewhere on your filesystem with

     git clone --recursive https://git.silence.dev/Silence/Silence-Android.git

  2. Make sure you have the Android SDK installed somewhere on your system.

  3. Ensure that the following packages are installed from the Android SDK manager:

    • Android SDK Build Tools
    • SDK Platform
    • Android Support Repository
    • Google Repository

  4. Create a local.properties file at the root of your source checkout and add an sdk.dir entry to it.

     sdk.dir=\<path to your sdk installation\>

  5. (Optional) Build Gradle-Witness

     ./scripts/build-witness.sh

  6. Execute Gradle:

     ./gradlew assembleDebug

If you get a Configuration with name 'default' not found., please update submodules:

    git submodule init && git submodule update

Visual assets

Sample command for generating our audio placeholder image:

pngs_from_svg.py ic_audio.svg /path/to/Silence/res/ 150 --color #000 --opacity 0.54 --suffix _light
pngs_from_svg.py ic_audio.svg /path/to/Silence/res/ 150 --color #fff --opacity 1.00 --suffix _light

Translations

Translations are available on Weblate and automatically updated in the source code. Make sure you run on the latest master revision.

Setting up a development environment

Android Studio is the recommended development environment.

  1. Install Android Studio.
  2. Make sure the "Android Support Repository" is installed in the Android Studio SDK.
  3. Make sure the latest "Android SDK build-tools" is installed in the Android Studio SDK.
  4. Create a new Android Studio project. from the Quickstart pannel (use File > Close Project to see it), choose "Checkout from Version Control" then "git".
  5. Paste the URL for the Silence project when prompted (https://github.com/SilenceIM/Silence.git).
  6. Android studio should detect the presence of a project file and ask you whether to open it. Click "yes".
  7. Default config options should be good enough.
  8. Project initialisation and build should proceed.

Contributing code

Code contributions should be sent via GitLab as merge requests, from feature branches.