Table of Contents

  1. Introduction
  2. Downloading the Code
  3. Importing the Project
  4. Name, Package, and Icon
  5. Metadata

Introduction

The first you need to do is download Polar from GitHub. A lot of you probably already understand how GitHub works, but I know some designers haven't had to use it before. We thought it would be helpful to have a basic guide to get the source code from GitHub. You'll need to know how to do this for upgrades, too.


Downloading the Code

First, you need to download the project to the computer that you use for design/development. There are three ways to do this:

  1. Download a ZIP file from the GitHub repo.
  2. Through the GitHub desktop client.
  3. Through the Command Prompt (Windows) or Terminal (OSX/Linux).

>> ZIP Archive

If you choose to download a ZIP file, it's pretty straightforward, but harder to keep up to date when things change remotely.

>> Desktop Client

If you choose to use the GitHub desktop client, an extra step is required that makes the process a bit longer. First, you need to fork the main repository. Basically, this copies Polar from my (Aidan's) profile into your own. It's important to know that when I update the main repository, forks of it are not automatically updated. You have to do that yourself.

Once you've forked the repository, you can clone your fork from the GitHub desktop client.

>> Command Prompt/Terminal

I don't want to go over all of the specifics of how you setup Git to work from CMD/Terminal, so I will assume anyone that will be using this already understands how to set it up and use it.

You don't have to fork the repository, or even login. All that you need is the SSH URL from the main repository.

With that SSH URL, you can clone the repository into the current directory using git clone git@github.com:afollestad/polar-dashboard.git, and you can retrieve repository updates using git pull origin master (although this will generally be messy when you are editing a lot of local files that I also modify remotely).


Importing the Project

Importing the downloaded project into Android Studio is relatively simple. There are two different places where you can initialize importation.

From the Start Page

If you are on the startup page, you need to import the project as a Gradle project:

Then choose Polar's folder, and click OK:

From Elsewhere

If you already have another project open, you can import a project like this:

You select a project folder to import the same way you would above. It will ask you if you want to open the project in the current window, or a new window.


Name, Package, and Icon

First, you need to change the name of the dashboard to the name of your icon pack. This can be done from /res/values/strings.xml as seen in the image below. Make sure you update the first two strings to replace "Polar". The second is used in Muzei.

Your launcher (home screen) icon goes into the mipmap prefixed folders in /res.

You will also need to update your applicationId (your pack's unique identifier which will also be used on Google Play) in /app/build.gradle. It is however possible that the refactoring step from the Getting Started page updated this for you already. You also manage your app's version (versionCode and versionName) from this file.


Metadata

There are a few files which are used by very specific launchers, such as Apex launcher. It's important that you fill in the information in these files so that launchers like Apex display the correct name and icon for your pack.

These files include themecfg.xml and themeinfo.xml, which exist in both /res/xml and /assets. Along with theme_config.xml which exists in res/values.

themeinfo.xml looks like this:

themecfg.xml looks like this:

theme_config.xml looks like this: