Skip to content

Commit 9d5be4a

Browse files
author
Titouan Thibaud
committed
Update documentation to include the video showing the app features
1 parent 45244e6 commit 9d5be4a

File tree

2 files changed

+39
-1
lines changed

2 files changed

+39
-1
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
.externalNativeBuild
1717
.cxx
1818
local.properties
19+
/temp-doc
1920

2021
# Compiled python code
2122
*.pyc

README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,34 @@
1-
# Fenix Installer
1+
<p align="center">
2+
<img src="app/src/main/res/mipmap-xxxhdpi/ic_launcher_foreground.webp" alt="TryFox icon" width="220" />
3+
</p>
4+
5+
<h1>TryFox</h1>
26

37
A simple Android app to search, download, and install Fenix (Firefox for Android), Focus, and other Mozilla Android project APKs from CI builds.
48

9+
## Install TryFox
10+
11+
Install the latest APK from [TryFox Releases](https://github.com/mozilla-mobile/TryFox/releases/latest).
12+
13+
To make TryFox handle Treeherder links on Android:
14+
15+
1. Install TryFox an
16+
2. Open Android `Settings`.
17+
3. Go to `Apps` or `Applications`.
18+
3. Select `TryFox`.
19+
4. Open `Open by default`.
20+
5. Tap `Supported web addresses` or `Add link`.
21+
6. Enable `treeherder.mozilla.org`.
22+
7. If your device shows an `Open supported links` toggle or menu, set it to `Open in this app`.
23+
24+
After that, opening a Treeherder URL such as `https://treeherder.mozilla.org/jobs?repo=try&revision=<REVISION>` should offer or directly open TryFox, depending on your Android version and current default-browser settings.
25+
526
## Features
627

28+
<video src="doc/tryfox-demo-jan-2026.mp4" controls muted playsinline width="720">
29+
Your browser does not support the video tag.
30+
</video>
31+
732
- **Multi-Project Support**: Select from projects:
833
- `try` (default)
934
- `mozilla-central` (displayed as "central")
@@ -65,6 +90,18 @@ A simple Android app to search, download, and install Fenix (Firefox for Android
6590
./gradlew assembleDebug
6691
```
6792

93+
Run unit tests:
94+
95+
```bash
96+
./gradlew testDebugUnitTest
97+
```
98+
99+
Run Android instrumentation tests with a connected device or running emulator:
100+
101+
```bash
102+
./gradlew connectedDebugAndroidTest
103+
```
104+
68105
## Architecture
69106

70107
- **Jetpack Compose** for UI (Material 3 theming).

0 commit comments

Comments
 (0)