Merge pull request #18 from google/2018

Santa Tracker 2018 source code import

.gitignore

@@ -1,9 +1,37 @@
-.gradle
-local.properties
-.idea
+# built application files
+*.apk
+*.ap_
+
+# files for the dex VM
+*.dex
+
+# Java class files
+*.class
+
+# generated files
+bin/
 build/
+gen/
+out/
+
+# Local configuration file (sdk path, etc)
+local.properties
+
+# Eclipse project files
+.classpath
+.project
+
+# Windows thumbnail db
 .DS_Store
+
+# Idea project fileS
 *.iml
-*.apk
-*.zip
-google-services.json
+*.ipr
+*.iws
+.idea/
+
+# Gradle config files
+.gradle/
+
+# Sandbox stuff
+_sandbox

CONTRIBUTING.md

@@ -1,35 +1,28 @@
-# How to become a contributor and submit your own code
+# How to Contribute
 
-## Contributor License Agreements
+We'd love to accept your patches and contributions to this project. There are
+just a few small guidelines you need to follow.
 
-We'd love to accept your sample apps and patches! Before we can take them, we
-have to jump a couple of legal hurdles.
+## Contributor License Agreement
 
-Please fill out either the individual or corporate Contributor License Agreement (CLA).
+Contributions to this project must be accompanied by a Contributor License
+Agreement. You (or your employer) retain the copyright to your contribution;
+this simply gives us permission to use and redistribute your contributions as
+part of the project. Head over to <https://cla.developers.google.com/> to see
+your current agreements on file or to sign a new one.
 
-  * If you are an individual writing original source code and you're sure you
-    own the intellectual property, then you'll need to sign an [individual CLA]
-    (https://developers.google.com/open-source/cla/individual).
-  * If you work for a company that wants to allow you to contribute your work,
-    then you'll need to sign a [corporate CLA]
-    (https://developers.google.com/open-source/cla/corporate).
+You generally only need to submit a CLA once, so if you've already submitted one
+(even if it was for a different project), you probably don't need to do it
+again.
 
-Follow either of the two links above to access the appropriate CLA and
-instructions for how to sign and return it. Once we receive it, we'll be able to
-accept your pull requests.
+## Code reviews
 
-## Contributing A Patch
+All submissions, including submissions by project members, require review. We
+use GitHub pull requests for this purpose. Consult
+[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
+information on using pull requests.
 
-1. Submit an issue describing your proposed change to the repo in question.
-1. The repo owner will respond to your issue promptly.
-1. If your proposed change is accepted, and you haven't already done so, sign a
-   Contributor License Agreement (see details above).
-1. Fork the desired repo, develop and test your code changes.
-1. Ensure that your code adheres to the existing style in the sample to which
-   you are contributing. Refer to the
-   [Android Code Style Guide]
-   (https://source.android.com/source/code-style.html) for the
-   recommended coding standards for this organization.
-1. Ensure that your code has an appropriate set of unit tests which all pass.
-1. Submit a pull request.
+## Community Guidelines
 
+This project follows
+[Google's Open Source Community Guidelines](https://opensource.google.com/conduct/).

README.md

@@ -1,17 +1,23 @@
-Google Santa Tracker for Android
+Google Santa Tracker for Android 🎅🤶
 ================================
 
 ## About
 
-[Google Santa Tracker app for Android][play-store] is an educational and entertaining tradition that brings joy to millions of children (and children at heart) across the world over the December holiday period. The app is a companion to the [Google Santa Tracker][santa-web] website ([repository here](https://github.com/google/santa-tracker-web)), showcasing unique platform capabilities like Android Wear watchfaces, device notifications and more.
-![Analytics](https://ga-beacon.appspot.com/UA-12846745-20/santa-tracker-android/readme?pixel)
+[Google Santa Tracker app for Android][play-store] is an educational and entertaining tradition
+that brings joy to millions of children (and children at heart) across the world over the December
+holiday period.
 
-<img src="res/village.png" height="640" width="360" alt="Village Screenshot" />
+The app is a companion to the [Google Santa Tracker][santa-web] website
+([repository here](https://github.com/google/santa-tracker-web)), showcasing unique platform
+capabilities like Android Wear watchfaces, device notifications and more.
+
+![Village Screenshot](docs/village.png)
 
 ## Features
 
-* A beautiful materially designed village
+* A beautiful designed village
 * Exciting games like Penguin Swim and Rocket Sleigh
+* Use of Dynamic Feature Modules (each game is a separate module, fetched dynamically on first run)
 * Interactive Android Wear watchfaces (with sound!)
 * Videos, animations and more.
 
@@ -23,34 +29,32 @@ console, follow these steps:
 
  * Create a new project
  * Add Firebase to your Android app
-  * Package name: `com.google.android.apps.santatracker.debug`
-  * Debug signing certificate can be blank, or follow the instructions in the
-    tooltip to find yours.
+ * Package name: `com.google.android.apps.santatracker.debug`
+ * Debug signing certificate can be blank, or follow the instructions in the tooltip to find yours.
  * Save the `google-services.json` file to the `santa-tracker/` directory
 
 Now you should be able to plug your phone in (or fire up an emulator) and run:
 
-    ./gradlew santa-tracker:installDevelopmentDebug
+    ./gradlew santa-tracker:installDebug
 
 Alternatively, import the source code into Android Studio (File, Import Project).
 
-Note: You'll need Android SDK version 24, build tools 24.0.0, and the Android Support Library to
-compile the project. If you're unsure about this, use Android Studio and tick the appropriate boxes
-in the SDK Manager.
+Note: You'll need Android SDK version 28. If you're unsure about this, use
+Android Studio and tick the appropriate boxes in the SDK Manager.
 
 ## License
-All image and audio files (including *.png, *.jpg, *.svg, *.mp3, *.wav
-and *.ogg) are licensed under the CC-BY-NC license. All other files are
-licensed under the Apache 2 license. See the LICENSE file for details.
 
+All image and audio files (including *.png, *.jpg, *.svg, *.mp3, *.wav, *.ogg, *.m4a, *.webp) are
+licensed under the CC-BY-NC license. All other files are licensed under the Apache 2 license.
+See the LICENSE file for details.
 
-    Copyright 2016 Google Inc. All rights reserved.
+    Copyright 2019 Google LLC
 
     Licensed under the Apache License, Version 2.0 (the "License");
     you may not use this file except in compliance with the License.
     You may obtain a copy of the License at
 
-        http://www.apache.org/licenses/LICENSE-2.0
+        https://www.apache.org/licenses/LICENSE-2.0
 
     Unless required by applicable law or agreed to in writing, software
     distributed under the License is distributed on an "AS IS" BASIS,