Skip to content

Update FXIOS-15319 Move bootstrap to archived-scripts and update READMEs #32894

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
adudenamedruby wants to merge 1 commit into
base: main
Choose a base branch
from
+3 −60
Draft

Update FXIOS-15319 Move bootstrap to archived-scripts and update READMEs #32894

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 2 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,6 @@ This is a monolithic-repository, containing both the Firefox and Focus iOS proje

As this is an iOS project, it is required to have Xcode on your system, and you should check that `xcode-select -p` points to `/Applications/Xcode.app/Contents/Developer` (or however you've named your `Xcode.app`).

### Automatic Installation

The recommended way of setting up the repo is through the [fxios](https://github.com/mozilla-mobile/fxios-ctl) tool. This tool provides multiple helpful commands to help manage the repo. Check out its documentation, or the repo, if you'd like to find out more. Setup allows cloning from an https or an ssh url.

Note that, if you're using a fork, you'll have to use the `--with-fork <fork-url>` option. This will set your fork as `origin` and the main firefox-ios repo as `upstream`. `fork-url` can be either the ssh or the https version.
Expand All @@ -44,7 +42,7 @@ fxios setup --ssh --with-fork <fork-url>
For more options for setup, please run `fxios setup --help`.
Please note, this is a decently sized repo, so downloading might take a while depending on your connection.

#### Firefox Instructions
### Firefox Instructions

1. Open the `Client.xcodeproj`, under the `firefox-ios/firefox-ios` folder, in Xcode.
1. Make sure to select the `Fennec` scheme in Xcode.
Expand All @@ -53,19 +51,11 @@ Please note, this is a decently sized repo, so downloading might take a while de

Xcode -> File -> Packages -> Reset Package Caches

#### Focus Instructions
### Focus Instructions

1. Open `Blockzilla.xcodeproj`, under the `firefox-ios/focus-ios` folder, in Xcode.
1. Build the `Focus` scheme in Xcode.

### Manual Installation

1. Clone the repo locally
1. For their related build instructions, please follow the respective project readmes:

- [Firefox for iOS](./firefox-ios/README.md)
- [Focus iOS](./focus-ios/README.md)

## Getting involved

We encourage you to participate in those open source projects. We love Pull Requests, Issue Reports, Feature Requests or any kind of positive contribution. Please read the [Mozilla Community Participation Guidelines](https://www.mozilla.org/en-US/about/governance/policies/participation/) and our [Contributing guidelines](https://github.com/mozilla-mobile/firefox-ios/blob/main/CONTRIBUTING.md) first.
Expand Down
0 bootstrap.sh → archived-scripts/bootstrap.sh
View file
Open in desktop
File renamed without changes.
31 changes: 1 addition & 30 deletions firefox-ios/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,35 +8,6 @@ For details on compatible Xcode and Swift versions used to build this project, a

For information on how to contribute to this project, including communication channels, coding style, PR naming guidelines and more, visit the [Contribution guidelines](https://github.com/mozilla-mobile/firefox-ios/blob/main/CONTRIBUTING.md).

## Building the code
Copy link
Copy Markdown
Contributor

@lmarceau lmarceau Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't we provide some guidance for contributors to know how to build the code? At least pointing to fxios?

Also some steps should stay IMO even with fxios:

1. Open the `Client.xcodeproj` under the `firefox-ios` folder in Xcode.
1. Make sure to select the `Fennec` [scheme](https://developer.apple.com/documentation/xcode/build-system?changes=_2) in Xcode.
1. Select the destination device you want to build on.
1. Run the app with `Cmd + R` or by pressing the `build and run` button.

⚠️ Important: In case you have dependencies issues with SPM, please try the following:

- Xcode -> File -> Packages -> Reset Package Caches

Copy link
Copy Markdown
Contributor Author

@adudenamedruby adudenamedruby Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These steps all exist in the main readme for fxios

Copy link
Copy Markdown
Contributor

@lmarceau lmarceau Apr 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But if I am a contributor, how do I know I need to use fxios ?

Copy link
Copy Markdown
Contributor Author

@adudenamedruby adudenamedruby Apr 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That information already exist in the main README :)


1. Install the version of [Xcode](https://developer.apple.com/download/applications/) from Apple that matches what this project uses, as listed in the root [README](../README.md).
1. Node.js is required, e.g. installed via [Brew](https://brew.sh), with [n](https://github.com/tj/n#readme), or just [n-install](https://github.com/mklement0/n-install#readme) depending whether you want to use a package manager:
```shell
brew install n # or, skipping brew: curl -L https://bit.ly/n-install | bash
n lts
```
1. Clone the repository:
```shell
git clone https://github.com/mozilla-mobile/firefox-ios
```
1. Change directories to the project root:
```shell
cd firefox-ios
```
1. From the project root, install Node.js dependencies, build user scripts and update content blocker:
```shell
sh ./bootstrap.sh
```
1. Open the `Client.xcodeproj` under the `firefox-ios` folder in Xcode.
1. Make sure to select the `Fennec` [scheme](https://developer.apple.com/documentation/xcode/build-system?changes=_2) in Xcode.
1. Select the destination device you want to build on.
1. Run the app with `Cmd + R` or by pressing the `build and run` button.

⚠️ Important: In case you have dependencies issues with SPM, please try the following:

- Xcode -> File -> Packages -> Reset Package Caches

## Building User Scripts

User Scripts (JavaScript injected into the `WKWebView`) are compiled, concatenated, and minified using [webpack](https://webpack.js.org/). User Scripts to be aggregated are placed in the following directories:
Expand Down Expand Up @@ -79,6 +50,6 @@ npm run build

## Updating License Acknowledgements

In the app, the Settings > Licenses screen credits open source packages we use to build Firefox for iOS.
In the app, the Settings > Licenses screen credits open source packages we use to build Firefox for iOS.

If you add a new third party package or resource, please update the credits. Follow the instructions in our `license_plist_config.yml` file.
18 changes: 0 additions & 18 deletions focus-ios/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,3 @@ For details on compatible Xcode and Swift versions used to build this project, a
## Getting Involved

For information on how to contribute to this project, including communication channels, coding style, PR naming guidelines and more, visit the [Contribution guidelines](https://github.com/mozilla-mobile/firefox-ios/blob/main/CONTRIBUTING.md).

## Build Instructions

1. Install the version of [Xcode](https://developer.apple.com/download/applications/) from Apple that matches what this project uses, as listed in the root [README](../README.md).
1. Clone the repository:
```shell
git clone https://github.com/mozilla-mobile/firefox-ios.git
```
1. Change directories to the project root:
```shell
cd firefox-ios
```
1. Pull in the project dependencies using the bootstrap script (pass in `focus` as the product argument):
```shell
./bootstrap.sh focus
```
1. Open `Blockzilla.xcodeproj` under the `focus-ios` folder in Xcode.
Copy link
Copy Markdown
Contributor

@lmarceau lmarceau Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment about Focus

Copy link
Copy Markdown
Contributor Author

@adudenamedruby adudenamedruby Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These steps all exist in the main readme for fxios

1. Build the `Focus` scheme in Xcode.
Loading