[fenix] Update to Mozilla Android Components 0.45.0-SNAPSHOT and GeckoView Nightly...
[gecko.git] / mobile / android / fenix / README.md
blob7fa3737c064b642b89979022305a3fe6183a30ca
1 # Firefox Fenix
3 Firefox Fenix is a new browser for Android
5 ## Getting Involved
7 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. 
9 Before you attempt to make a contribution please read the [Community Participation Guidelines](https://www.mozilla.org/en-US/about/governance/policies/participation/).
11 * [Guide to Contributing](https://github.com/mozilla-mobile/shared-docs/blob/master/android/CONTRIBUTING.md) (**New contributors start here!**)
13 * [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].
15 * IRC: [#focus (irc.mozilla.org)](https://wiki.mozilla.org/IRC) | [view logs](https://mozilla.logbot.info/fenix/)
16 (**We're available Monday-Friday, GMT and PST working hours**).
18 * [View the Wiki](https://github.com/mozilla-mobile/fenix/wiki).
20 **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!
23 ## Build Instructions
26 1. Clone or Download the repository:
28   ```shell
29   git clone https://github.com/mozilla-mobile/fenix
30   ```
32 2. Import the project into Android Studio **or** build on the command line:
34   ```shell
35   ./gradlew clean app:assembleArmDebug
36   ```
38 3. Make sure to select the correct build variant in Android Studio:
39 **armDebug** for ARM
40 **x86Debug** for X86
42 ## Pre-push hooks
43 To reduce review turn-around time, we'd like all pushes to run tests locally. We'd
44 recommend you use our provided pre-push hook in `config/pre-push-recommended.sh`.
45 Using this hook will guarantee your hook gets updated as the repository changes.
46 This hook tries to run as much as possible without taking too much time.
48 To add it, run this command from the project root:
49 ```sh
50 ln -s ../../config/pre-push-recommended.sh .git/hooks/pre-push
51 ```
53 To push without running the pre-push hook (e.g. doc updates):
54 ```sh
55 git push <remote> --no-verify
56 ```
58 ## License
61     This Source Code Form is subject to the terms of the Mozilla Public
62     License, v. 2.0. If a copy of the MPL was not distributed with this
63     file, You can obtain one at http://mozilla.org/MPL/2.0/