This repository has been archived by the owner on Feb 20, 2023. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add project README and pre-push-hook
- Loading branch information
1 parent
b2b6a53
commit 8af5565
Showing
2 changed files
with
69 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
#!/bin/sh | ||
|
||
./gradlew -q \ | ||
ktlint \ | ||
detekt \ | ||
app:assembleX86Debug |