From 52b4a9f14c5a293ee966aab83ec17129881cf840 Mon Sep 17 00:00:00 2001 From: Moririn Date: Mon, 18 Sep 2023 17:01:58 +0100 Subject: [PATCH] Update README.md --- README.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index f1a2749..17a60e3 100644 --- a/README.md +++ b/README.md @@ -4,25 +4,26 @@ Included theme originally modified from [Filip Sutkowy's *blurclean-firefox-them ## Description This script will create or modify the following files and directories: -+ `/chrome/` and subsidiary CSS files will be created if they do not exist, or overwritten if `-o` is passed, in order to provide the necessary styles ++ `$XDG_CONFIG_HOME/foxtheme/chrome/` and subsidiary CSS files will be created if they do not exist, or overwritten if `-o` is passed, in order to provide the necessary styles ++ `/chrome` will be created as a symlink to `$XDG_CONFIG_HOME/foxtheme/chrome/` + `/user.js` will be created if it does not exist, or appended to in the case of an existing `user.js`, in order to modify the necessary `about:config` settings for the theme -+ `/user-overrides.js` will be created if it does not exist, or appended to in the case of an existing `user-overrides.js`, with the same modifications as the regular `user.js` file in order to ensure current or a potential future compatibility with the [arkenfox user.js (GitHub)](https://github.com/arkenfox/user.js) or similar - -Note: `user.js` files are read "top-to-bottom" by the browser, thus giving priority to the final alteration of a given preference that appears within the file. As such, the appending of the necessary preferences for this theme may overwrite users' existing settings for those preferences. ++ `/user-overrides.js` will be created instead of `user.js` if it does not exist and `-r` is passed, or appended to in the case of an existing `user-overrides.js`, with the same modifications as the regular `user.js` file in order to ensure current or a potential future compatibility with the [arkenfox user.js (GitHub)](https://github.com/arkenfox/user.js) or similar ## Options ``` Usage: ./foxtheme.sh [OPTIONS] [PROFILE | -a PROFILESDIR] --a Apply theme to all (current) browser profiles --j Just create or modify user.js and not user-overrides.js --o Remove and replace an existing theme if found -h Display this help message +-o Remove and replace an existing theme if found +-a Apply theme to all (current) browser profiles +-r Apply modifications to user-overrides.js instead of user.js +-d Don't modify existing user.js values. May cause the theme to behave incorrectly ``` ## Custom themes This script is ultimately just a glorified wrapper for: ``` -cp -r chrome/ / +mkdir $XDG_CONFIG_DIR/foxtheme/ +cp -r chrome/ $XDG_CONFIG_DIR/foxtheme/ +ln -s -f $XDG_CONFIG_DIR/foxtheme/chrome/ cat user.js >> /user.js -cat user.js >> /user-overrides.js ``` -As such, replacing the `user.js` or contents of the `chrome` directory with custom preferences and themes should offer the same functionality. +As such, replacing the supplied `user.js` or contents of the `chrome` directory with custom preferences and themes should offer the same functionality.