Update README
This commit is contained in:
parent
5e796d330d
commit
f8e992011c
61
README.md
61
README.md
|
@ -35,37 +35,61 @@ Theme versions compatible with older Firefox releases are preserved as git tags.
|
||||||
|
|
||||||
We also have the `beta` and `nightly` branches for fixes only applicable to the current Firefox beta and nightly versions.
|
We also have the `beta` and `nightly` branches for fixes only applicable to the current Firefox beta and nightly versions.
|
||||||
|
|
||||||
## Installation
|
## One command install with curl
|
||||||
|
|
||||||
|
To install this theme, you can run this command, which uses *curl* to download a script that will also download the latest released version of the theme (not the master version) and run the **auto-install** script for you.
|
||||||
|
|
||||||
|
> **Warning**: Always be careful when running scripts from the Internet.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
curl -s -o- https://raw.githubusercontent.com/rafaelmardojai/firefox-gnome-theme/master/scripts/install-by-curl.sh | bash
|
||||||
|
```
|
||||||
|
|
||||||
|
## Installation scripts
|
||||||
|
|
||||||
|
If you want to use other version of the theme than the stable one you can manually download the theme and run its install scripts.
|
||||||
|
|
||||||
|
First you need to grab a fresh copy of the theme repository by cloning it with git.
|
||||||
|
|
||||||
### Installation script
|
|
||||||
1. Clone this repo and enter folder:
|
1. Clone this repo and enter folder:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
git clone https://github.com/rafaelmardojai/firefox-gnome-theme.git && cd firefox-gnome-theme
|
git clone https://github.com/rafaelmardojai/firefox-gnome-theme.git
|
||||||
|
cd firefox-gnome-theme
|
||||||
```
|
```
|
||||||
2. Checkout a git branch or tag if needed, otherwise use `master` and ignore this step.
|
2. Checkout a git branch or tag if needed, otherwise use `master` and ignore this step.
|
||||||
```sh
|
```sh
|
||||||
git checkout beta # Set beta branch
|
git checkout beta # Set beta branch
|
||||||
git checkout v78.1 # Set v78.1 tag
|
git checkout v78.1 # Set v78.1 tag
|
||||||
git checkout v$(firefox --version | cut -d ' ' -f 3 | cut -d '.' -f 1) # Using Firefox version
|
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Run installation script
|
This theme provides two installation scripts in addition to the curled one.
|
||||||
|
|
||||||
#### Auto install script
|
### Auto install script
|
||||||
|
|
||||||
|
This script will look for Firefox profiles from various known locations (`~/.mozilla/firefox/`, Flatpak, Snap, etc) and install the theme in each one.
|
||||||
|
It will also enable a color variant for your GTK theme if it exists.
|
||||||
|
|
||||||
|
You can execute it by running:
|
||||||
|
|
||||||
This script will lookup Firefox profiles location and enable a theme variant for your GTK theme if it exists.
|
|
||||||
```sh
|
```sh
|
||||||
./scripts/auto-install.sh
|
./scripts/auto-install.sh
|
||||||
```
|
```
|
||||||
#### Install script
|
|
||||||
|
### Manual install script
|
||||||
|
|
||||||
|
This script will only install the theme into the profiles found in the default Firefox folder `~/.mozilla/firefox/`. The script accepts various flags to change its behavior.
|
||||||
|
|
||||||
|
Here are some examples of how to use it:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
./scripts/install.sh # Standard
|
./scripts/install.sh # Standard
|
||||||
|
./scripts/install.sh -p pc8577yz.default-release # Only install in a profile named pc8577yz.default-release
|
||||||
./scripts/install.sh -f ~/.var/app/org.mozilla.firefox/.mozilla/firefox # Flatpak
|
./scripts/install.sh -f ~/.var/app/org.mozilla.firefox/.mozilla/firefox # Flatpak
|
||||||
./scripts/install.sh -f ~/snap/firefox/common/.mozilla/firefox #Snap
|
./scripts/install.sh -f ~/snap/firefox/common/.mozilla/firefox #Snap
|
||||||
```
|
```
|
||||||
|
|
||||||
##### Script options
|
#### Script options
|
||||||
- `-f <firefox_folder_path>` *optional*
|
- `-f <firefox_folder_path>` *optional*
|
||||||
- Set custom Firefox folder path, for example `~/.mozilla/icecat/`.
|
- Set custom Firefox folder path, for example `~/.mozilla/icecat/`.
|
||||||
- Default: `~/.mozilla/firefox/`
|
- Default: `~/.mozilla/firefox/`
|
||||||
|
@ -79,17 +103,23 @@ We also have the `beta` and `nightly` branches for fixes only applicable to the
|
||||||
- Default: Adwaita.
|
- Default: Adwaita.
|
||||||
- Options: `adwaita`, `maia`.
|
- Options: `adwaita`, `maia`.
|
||||||
|
|
||||||
### One command curled script
|
<details>
|
||||||
|
<summary>Advanced notes</summary>
|
||||||
|
|
||||||
You can also install this theme with one command:
|
### Advanced notes
|
||||||
|
|
||||||
|
If you want to checkout the theme version tag matching you Firefox version you can run:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
curl -s -o- https://raw.githubusercontent.com/rafaelmardojai/firefox-gnome-theme/master/scripts/install-by-curl.sh | bash
|
git checkout v$(firefox --version | cut -d ' ' -f 3 | cut -d '.' -f 1) # Using Firefox version
|
||||||
```
|
```
|
||||||
|
</details>
|
||||||
|
|
||||||
It will download the latest version of the theme and run the auto installation script for you.
|
<details>
|
||||||
|
<summary>Manual installation</summary>
|
||||||
|
|
||||||
|
## Manual installation
|
||||||
|
|
||||||
### Manual installation
|
|
||||||
1. Go to `about:support` in Firefox.
|
1. Go to `about:support` in Firefox.
|
||||||
|
|
||||||
2. Application Basics > Profile Directory > Open Directory.
|
2. Application Basics > Profile Directory > Open Directory.
|
||||||
|
@ -135,8 +165,9 @@ It will download the latest version of the theme and run the auto installation s
|
||||||
10. Open Firefox customization panel and move the new tab button to headerbar.
|
10. Open Firefox customization panel and move the new tab button to headerbar.
|
||||||
|
|
||||||
11. Be happy with your new gnomish Firefox.
|
11. Be happy with your new gnomish Firefox.
|
||||||
|
</details>
|
||||||
|
|
||||||
### Required Firefox preferences
|
## Required Firefox preferences
|
||||||
We provide a **user.js** configuration file in `configuration/user.js` that enable some preferences required by this theme to work.
|
We provide a **user.js** configuration file in `configuration/user.js` that enable some preferences required by this theme to work.
|
||||||
|
|
||||||
You should already have this file installed if you followed one of the installation methods, but in any case be sure this preferences are enabled under `about:config`:
|
You should already have this file installed if you followed one of the installation methods, but in any case be sure this preferences are enabled under `about:config`:
|
||||||
|
|
Loading…
Reference in New Issue