From 1c21efc290dba3337eb6a7795dd2643111bdbec0 Mon Sep 17 00:00:00 2001 From: SplatboyDev <64037464+splatboydev@users.noreply.github.com> Date: Thu, 17 Nov 2022 15:06:12 +0100 Subject: [PATCH 1/7] Fix Windows docs link --- docs/content/getting-started/overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/getting-started/overview.md b/docs/content/getting-started/overview.md index 22b7e4d..f0383f5 100644 --- a/docs/content/getting-started/overview.md +++ b/docs/content/getting-started/overview.md @@ -15,7 +15,7 @@ If you are having problems with following these instructions, or with gluon in g ### System requirements -- **OS**: Linux and MacOS (If you are using windows, take a look at the [Windows Guide](../windows/)) +- **OS**: Linux and MacOS (If you are using windows, take a look at the [Windows Guide](../guides/windows/)) - **Gluon dependencies**: NodeJS and npm - **Browser dependencies**: Will be handled by bootstrapping From d7157069754b58852143b54d25c5bf84b60a568f Mon Sep 17 00:00:00 2001 From: SplatboyDev <64037464+splatboydev@users.noreply.github.com> Date: Sat, 14 Jan 2023 19:44:07 +0100 Subject: [PATCH 2/7] =?UTF-8?q?=E2=AD=90Add=20semicolons=20to=20pocket=20g?= =?UTF-8?q?uide?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit If you don't add semicolons, it won't work. --- docs/content/guides/removingPocket.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/content/guides/removingPocket.md b/docs/content/guides/removingPocket.md index 6f9425f..0363b36 100644 --- a/docs/content/guides/removingPocket.md +++ b/docs/content/guides/removingPocket.md @@ -12,22 +12,22 @@ weight = 5 The goal of this guide is to disable pocket and remove its icon from the toolbar. The first changes we will need to make is to the firefox.js file located in `engine/browser/app/profile/firefox.js`. Scroll to the lines that include the following settings (around line 1980 in firefox 94): ```js -pref('extensions.pocket.api', 'api.getpocket.com') -pref('extensions.pocket.enabled', true) -pref('extensions.pocket.oAuthConsumerKey', '40249-e88c401e1b1f2242d9e441c4') -pref('extensions.pocket.site', 'getpocket.com') -pref('extensions.pocket.onSaveRecs', true) -pref('extensions.pocket.onSaveRecs.locales', 'en-US,en-GB,en-CA') +pref('extensions.pocket.api', 'api.getpocket.com'); +pref('extensions.pocket.enabled', true); +pref('extensions.pocket.oAuthConsumerKey', '40249-e88c401e1b1f2242d9e441c4'); +pref('extensions.pocket.site', 'getpocket.com'); +pref('extensions.pocket.onSaveRecs', true); +pref('extensions.pocket.onSaveRecs.locales', 'en-US,en-GB,en-CA'); ``` Delete these lines and replace them with the following: ```js // Taken from BetterFox user.js -user_pref('extensions.pocket.enabled', false) -user_pref('extensions.pocket.api', ' ') -user_pref('extensions.pocket.oAuthConsumerKey', ' ') -user_pref('extensions.pocket.site', ' ') +user_pref('extensions.pocket.enabled', false); +user_pref('extensions.pocket.api', ' '); +user_pref('extensions.pocket.oAuthConsumerKey', ' '); +user_pref('extensions.pocket.site', ' '); ``` Next, you will need to remove pocket from the new tab page. You can do this by simply adding the following line to the bottom of `firefox.js`: @@ -36,7 +36,7 @@ Next, you will need to remove pocket from the new tab page. You can do this by s user_pref( 'browser.newtabpage.activity-stream.section.highlights.includePocket', false -) +); ``` Now you simply need to export the changes made to `firefox.js`: From fbfd1835948a65bd771c9e537979304bf6318518 Mon Sep 17 00:00:00 2001 From: SplatboyDev <64037464+splatboydev@users.noreply.github.com> Date: Sat, 14 Jan 2023 19:45:27 +0100 Subject: [PATCH 3/7] =?UTF-8?q?=F0=9F=A7=B6Yarn=20is=20not=20a=20dependenc?= =?UTF-8?q?y?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/content/guides/windows.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/content/guides/windows.md b/docs/content/guides/windows.md index b0d3bfe..0bc083a 100644 --- a/docs/content/guides/windows.md +++ b/docs/content/guides/windows.md @@ -29,7 +29,6 @@ You will need to install [MozillaBuild](https://ftp.mozilla.org/pub/mozilla/libr Install [NodeJS](https://nodejs.org/en/download/current/) on your system. This should also install chocolatey. If it does not, [install it manually](https://docs.chocolatey.org/en-us/choco/setup). To install the final two dependencies, run: ```sh -npm install --global yarn choco install make ``` From 7ea694e8083788a55a9bb0c48e4d208a1f9d3f8d Mon Sep 17 00:00:00 2001 From: SplatboyDev <64037464+splatboydev@users.noreply.github.com> Date: Sat, 14 Jan 2023 19:47:45 +0100 Subject: [PATCH 4/7] =?UTF-8?q?=F0=9F=93=99Correct=20capitalization?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/content/guides/windows.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/content/guides/windows.md b/docs/content/guides/windows.md index 0bc083a..0317e24 100644 --- a/docs/content/guides/windows.md +++ b/docs/content/guides/windows.md @@ -5,7 +5,7 @@ weight = 0 # Preparing Windows -Building on windows is significantly more complex than building on macos or linux. This guide will walk you through preparing your Windows machine for building a Firefox fork. Before building, you should be aware that [only Windows 10 or 11 are officially supported](https://firefox-source-docs.mozilla.org/build/buildsystem/supported-configurations.html#build-hosts), but you might be able to get other versions to work. +Building on Windows is significantly more complex than building on MacOS or Linux. This guide will walk you through preparing your Windows machine for building a Firefox fork. Before building, you should be aware that [only Windows 10 or 11 are officially supported](https://firefox-source-docs.mozilla.org/build/buildsystem/supported-configurations.html#build-hosts), but you might be able to get other versions to work. ## Installing Dependencies @@ -26,7 +26,7 @@ You will need to install [MozillaBuild](https://ftp.mozilla.org/pub/mozilla/libr - Configuring the line ending conversions must be: Checkout as-is, commit as-is - Enable experimental built-in file system monitor -Install [NodeJS](https://nodejs.org/en/download/current/) on your system. This should also install chocolatey. If it does not, [install it manually](https://docs.chocolatey.org/en-us/choco/setup). To install the final two dependencies, run: +Install [NodeJS](https://nodejs.org/en/download/current/) on your system. This should also install Chocolatey. If it does not, [install it manually](https://docs.chocolatey.org/en-us/choco/setup). To install the final two dependencies, run: ```sh choco install make @@ -36,13 +36,13 @@ You should be good to return back to the main [Getting Started docs](/getting-st ## Additional packages required for releasing -If you are creating binaries to target windows, you will need nsis (which mach calls `makensisu` for some reason, even though the binary is `makensis`): +If you are creating binaries to target Windows, you will need NSIS (which mach calls `makensisu` for some reason, even though the binary is `makensis`): ```powershell choco install nsis ``` -Note that you will also have to provide a path to nsis on your system. For mine it is: +Note that you will also have to provide a path to NSIS on your system. For mine it is: ```sh export MAKENSISU="C:\\Program Files (x86)\\NSIS\\Bin\\makensis.exe" From 8e5f2418ed3783b3bd58a445ad0985a886eefb49 Mon Sep 17 00:00:00 2001 From: SplatboyDev <64037464+splatboydev@users.noreply.github.com> Date: Sat, 14 Jan 2023 19:51:05 +0100 Subject: [PATCH 5/7] =?UTF-8?q?=E2=9C=A8Add=20punctuation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/content/reference/config.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/content/reference/config.md b/docs/content/reference/config.md index 064750e..c33752c 100644 --- a/docs/content/reference/config.md +++ b/docs/content/reference/config.md @@ -19,7 +19,7 @@ This is the name of the product that is to be built. ## vendor -The name of the company that is building the browser +The name of the company that is building the browser. ```json { @@ -29,7 +29,7 @@ The name of the company that is building the browser ## appId -A reverse DNS identifier for the browser +A reverse DNS identifier for the browser. ```json { @@ -49,7 +49,7 @@ The name of the output binary. ## updateHostname -The host of the update server for updating. This is configured as part of the build command +The host of the update server for updating. This is configured as part of the build command. ```json { @@ -149,7 +149,7 @@ These are flags that change how parts of Gluon operate. ### windowsUseSymbolicLinks -When set to `true`, symbolic links will be enabled on Windows. From internal testing, this appears to fail on a majority of computers +When set to `true`, symbolic links will be enabled on Windows. From internal testing, this appears to fail on a majority of computers. ## addons From bfad59dde852dbffb9a4cf82e5d0950d3cb2e9bc Mon Sep 17 00:00:00 2001 From: SplatboyDev <64037464+splatboydev@users.noreply.github.com> Date: Wed, 18 Jan 2023 19:08:15 +0100 Subject: [PATCH 6/7] =?UTF-8?q?=F0=9F=98=8A=20Make=20the=20docs=20welcome?= =?UTF-8?q?=20page=20more=20"welcoming"?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/content/_index.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/content/_index.md b/docs/content/_index.md index 1363ef3..225da95 100644 --- a/docs/content/_index.md +++ b/docs/content/_index.md @@ -3,6 +3,7 @@ title = "index" insert_anchor_links = "right" +++ -## Welcome to the Gluon docs +## Welcome to the Gluon documentation! If you are new here, you should read the [Getting Started](./getting-started/overview/) guide. +If you use Windows, you should read the [Windows instructions](./guides/windows.md). From 66bd23bafaadfdcc176906af26d8732868a8e9f9 Mon Sep 17 00:00:00 2001 From: SplatboyDev <64037464+splatboydev@users.noreply.github.com> Date: Mon, 7 Aug 2023 13:08:16 -0700 Subject: [PATCH 7/7] =?UTF-8?q?=F0=9F=A4=B7Remove=20period?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/content/guides/removingPocket.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/guides/removingPocket.md b/docs/content/guides/removingPocket.md index 0363b36..cd12260 100644 --- a/docs/content/guides/removingPocket.md +++ b/docs/content/guides/removingPocket.md @@ -47,7 +47,7 @@ gluon export-file browser/app/profile/firefox.js ## Removing pocket icon from toolbar -Whilst the steps above will have disabled pocket. The pocket icon will still be visible in the toolbar. Instead you must remove it from the CustomizableUI layout. Open `engine/browser/components/customizableui/CustomizableUI.jsm` and find the array that looks like this (around line 240): +Whilst the steps above will have disabled pocket, the pocket icon will still be visible in the toolbar. You must still remove it from the CustomizableUI layout. Open `engine/browser/components/customizableui/CustomizableUI.jsm` and find the array that looks like this (around line 240): ```js let navbarPlacements = [