From 8af55652be5c7c3058e5f53ffaa2925d67bd8602 Mon Sep 17 00:00:00 2001
From: Colin Lee <mncolinlee@gmail.com>
Date: Wed, 30 Jan 2019 12:13:23 -0600
Subject: [PATCH] Add project README and pre-push-hook

---
 README.md                      | 63 ++++++++++++++++++++++++++++++++++
 config/pre-push-recommended.sh |  6 ++++
 2 files changed, 69 insertions(+)
 create mode 100644 README.md
 create mode 100644 config/pre-push-recommended.sh

diff --git a/README.md b/README.md
new file mode 100644
index 000000000..7fa3737c0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,63 @@
+# Firefox Fenix
+
+Firefox Fenix is a new browser for Android
+
+## Getting Involved
+
+We encourage you to participate in this open source project. We love Pull Requests, Bug Reports, ideas, (security) code reviews or any other kind of positive contribution. 
+
+Before you attempt to make a contribution please read the [Community Participation Guidelines](https://www.mozilla.org/en-US/about/governance/policies/participation/).
+
+* [Guide to Contributing](https://github.com/mozilla-mobile/shared-docs/blob/master/android/CONTRIBUTING.md) (**New contributors start here!**)
+
+* [View current Issues](https://github.com/mozilla-mobile/fenix/issues), [view current Pull Requests](https://github.com/mozilla-mobile/fenix/pulls), or [file a security issue][sec issue].
+
+* IRC: [#focus (irc.mozilla.org)](https://wiki.mozilla.org/IRC) | [view logs](https://mozilla.logbot.info/fenix/)
+(**We're available Monday-Friday, GMT and PST working hours**).
+
+* [View the Wiki](https://github.com/mozilla-mobile/fenix/wiki).
+
+**Beginners!** - Watch out for [Issues with the "Good First Issue" label](https://github.com/mozilla-mobile/fenix/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22). These are easy bugs that have been left for first timers to have a go, get involved and make a positive contribution to the project!
+
+
+## Build Instructions
+
+
+1. Clone or Download the repository:
+
+  ```shell
+  git clone https://github.com/mozilla-mobile/fenix
+  ```
+
+2. Import the project into Android Studio **or** build on the command line:
+
+  ```shell
+  ./gradlew clean app:assembleArmDebug
+  ```
+
+3. Make sure to select the correct build variant in Android Studio:
+**armDebug** for ARM
+**x86Debug** for X86
+
+## Pre-push hooks
+To reduce review turn-around time, we'd like all pushes to run tests locally. We'd
+recommend you use our provided pre-push hook in `config/pre-push-recommended.sh`.
+Using this hook will guarantee your hook gets updated as the repository changes.
+This hook tries to run as much as possible without taking too much time.
+
+To add it, run this command from the project root:
+```sh
+ln -s ../../config/pre-push-recommended.sh .git/hooks/pre-push
+```
+
+To push without running the pre-push hook (e.g. doc updates):
+```sh
+git push <remote> --no-verify
+```
+
+## License
+
+
+    This Source Code Form is subject to the terms of the Mozilla Public
+    License, v. 2.0. If a copy of the MPL was not distributed with this
+    file, You can obtain one at http://mozilla.org/MPL/2.0/
\ No newline at end of file
diff --git a/config/pre-push-recommended.sh b/config/pre-push-recommended.sh
new file mode 100644
index 000000000..f1da7d89e
--- /dev/null
+++ b/config/pre-push-recommended.sh
@@ -0,0 +1,6 @@
+#!/bin/sh
+
+./gradlew -q \
+        ktlint \
+        detekt \
+        app:assembleX86Debug