Sky Map

This is the source repository for Sky Map. You should see the following two directories:

• app: Application source
• tools: Source for generating binary data used by the app.

To build SkyMap, you can use Android Developer Studio or Gradle. Begin by creating a local.properties file containing the location of your Android installation:

sdk.dir=<path to your SDK>

Android Developer Studio can create this for you. You can regenerate the datafiles and rebuild everything with the build_skymap.sh script.

Building

The build process is pretty horribles. To make it easier please use the shell script

./build_skymap.sh

(or its f-droid equivalent). This is the easiest way to tell if you've messed something up. If you just want to quickly regenerate an apk please see the following instructions (note: assembleRelease won't work because the f-droid flavor needs some tweaking which is done by the shell script - so make sure you build the Gms flavor specifically).

Building a debug apk

From the root directory execute

./gradlew assembleGmsDebug

The apk can be found in app/build/outputs/apk/.

Building a release apk

(Sky Map team only)

Create a file in the app directory called no-checkin.properties with appropriate values for the keys store-pwd= key-pwd= analytics-key=

and overwrite google-services.json with the correct file.

From the root directory execute

./gradlew assembleGms

or

./gradlew assembleGmsRelease

The apk can be found in app/build/outputs/apk/.

Running tests

Unit tests:

./gradlew test

Connected device/emulator required tests:

./gradlew app:connectedAndroidTest

Code and Language Contributions

Yes, we know that Sky Map's code and UX is very dated. It needs a big overhaul.

In general, bug fix contributions are welcome, for example, simple one file fixes or dependency version upgrades. We're particularly grateful for fixed or new translations since as the app is developed we lose the 100% coverage of non-English languages that we once had.

However, please email us (or file a feature request) first before embarking on any major changes or feature additions. We may have a different vision for the direction of the app and it would be a pity to do work that we can't accept and would be wasted.

It is likely we'll be slow to respond to emails and PR requests. Depending on what else is going on it might be days, it might be months. I do apologize for that - life is busy. Sometimes the reply might be simply to point you at this documentation, which will seem very ungrateful and unfriendly. Again, I apologize, but it's the only way to keep up with the emails.

Small, focussed PRs to fix bugs or upgrade dependencies etc are very easy for us to approve. If your PR does too much it might get stalled because even if 90% of it is welcome there might be 10% that we're not happy with. So keep them small if you can. Plus, we'll be able to review them faster.

Thanks for your contributions! They're definitely appreciated even if our slowness to respond might make it seem otherwise.

Coding Style

We follow the Google style guide (or try to). We wrap at 100 chars and we do not use the common Android style of prefixing member variables with a 'm'.