Updated 3.3 Updater Scripts (markdown)

Thorin-Oakenpants 2020-09-15 11:21:28 +00:00
parent 7044e3d4ba
commit 375d26ec8e

@ -1,5 +1,5 @@
Unless you want to use the `user.js` exactly as it is, you **must** follow our naming convention for [applying your changes](https://github.com/ghacksuserjs/ghacks-user.js/wiki/3.2-Applying-Your-Changes) for our updater scripts to work Unless you want to use the `user.js` exactly as it is, you **must** follow our naming convention for [applying your changes](https://github.com/arkenfox/user.js/wiki/3.2-Applying-Your-Changes) for our updater scripts to work
* profile\ `user-overrides.js` * profile\ `user-overrides.js`
* profile\ `user.js-overrides` \ `*.js` [Windows updater script only, multiple js files] * profile\ `user.js-overrides` \ `*.js` [Windows updater script only, multiple js files]
@ -8,7 +8,7 @@ Unless you want to use the `user.js` exactly as it is, you **must** follow our n
### :small_orange_diamond: Mac/Linux ### :small_orange_diamond: Mac/Linux
[Download](https://github.com/ghacksuserjs/ghacks-user.js/raw/master/updater.sh) the `updater.sh` script and save it in your profile folder. You can run it without any command line arguments and it will backup your current `user.js`, download the latest `ghacks user.js` and if it finds a `user-overrides.js` in the same folder it will append that to the `user.js`. [Download](https://github.com/arkenfox/user.js/raw/master/updater.sh) the `updater.sh` script and save it in your profile folder. You can run it without any command line arguments and it will backup your current `user.js`, download the latest `arkenfox user.js` and if it finds a `user-overrides.js` in the same folder it will append that to the `user.js`.
By default the updater script also compares its version number to the one online. If there's a newer version of `updater.sh` online, it asks you for confirmation to download and run it. Two command-line parameters are available to change this behavior (`-d` or `-u`). By default the updater script also compares its version number to the one online. If there's a newer version of `updater.sh` online, it asks you for confirmation to download and run it. Two command-line parameters are available to change this behavior (`-d` or `-u`).
@ -40,7 +40,7 @@ Optional Arguments:
### :small_orange_diamond: Windows ### :small_orange_diamond: Windows
[Download](https://github.com/ghacksuserjs/ghacks-user.js/raw/master/updater.bat) the `updater.bat` script and save it in your profile folder. You can run it without any command line arguments and it will backup your current `user.js`, download the latest `ghacks user.js` and if it finds a `user-overrides.js` in the same folder it will append that to the `user.js`. [Download](https://github.com/arkenfox/user.js/raw/master/updater.bat) the `updater.bat` script and save it in your profile folder. You can run it without any command line arguments and it will backup your current `user.js`, download the latest `arkenfox user.js` and if it finds a `user-overrides.js` in the same folder it will append that to the `user.js`.
!! Unicode encoded override files should be stored without the BOM header !! !! Unicode encoded override files should be stored without the BOM header !!
@ -66,7 +66,7 @@ the updater will auto-update itself on execution
- **v4.5+ supports commenting-out active user_pref lines** (see example below) - **v4.5+ supports commenting-out active user_pref lines** (see example below)
The following example illustrates how `-merge` works:<br><br> The following example illustrates how `-merge` works:<br><br>
ghacks user.js file contains this: arkenfox user.js file contains this:
```js ```js
/* 0103: set your "home" page (see 0102) ***/ /* 0103: set your "home" page (see 0102) ***/
// user_pref("browser.startup.homepage", "https://www.example.com/"); // user_pref("browser.startup.homepage", "https://www.example.com/");