Add some troubleshooting steps for building

This commit is contained in:
dillontkh 2025-03-06 22:11:17 +08:00
parent 4e5b077106
commit 8a4ca68ea0
3 changed files with 48 additions and 1 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.3 KiB

View file

@ -1,6 +1,6 @@
---
title: Building Zen Browser 📦
lastmod: 2024-09-25
lastmod: 2025-03-06
---
We've taken the time to make building Zen Browser as easy as possible, independent of your operating system or technical knowledge.
@ -29,6 +29,14 @@ pnpm i
This command will install all the packages listed in the `package.json` file, which are required for building and running Zen Browser.
If you see this error message:
<div align="center">
<img src="/assets/building/ignored-builds-warning.png" width="80%">
</div>
Run `pnpm approve-builds` and approve them.
## Step 3: Download and Bootstrap the Browser
To set up the browser, you need to download additional files and prepare the environment:
@ -68,3 +76,38 @@ pnpm start
```
This command launches the browser, allowing you to see your changes in action.
# Troubleshooting
<details>
<summary>[Windows] Error: ccache not found</summary>
Add `C:\Users\<your_user>\.mozbuild\sccache` to your PATH.
</details>
<details>
<summary>[Windows] Error: 7z not found</summary>
Download <a href="https://www.7-zip.org/download.html">7-zip</a> and add it to your PATH.
</details>
<details>
<summary>[All OS] My code changes are not being reflected even after building</summary>
If you are changing files in the `src/` directory:
```bash
pnpm run import
pnpm run build:ui
```
</details>
<details>
<summary>[All OS] Something went wrong installing the "sharp" module</summary>
You likely did not approve builds in [Step 2](#step-2-install-dependencies).
</details>

View file

@ -1,3 +1,7 @@
@use "./base.scss";
// put your custom CSS here!
summary {
cursor: pointer;
}