Improve README

add auto-install.sh info
This commit is contained in:
Rafael Mardojai CM 2021-05-11 07:47:19 -05:00
parent 6bb1d9e7c9
commit e754cab5fd
1 changed files with 25 additions and 14 deletions

View File

@ -27,34 +27,44 @@ This theme is supposed to work with current supported Firefox releases:
### Installation script ### 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/ && cd firefox-gnome-theme git clone https://github.com/rafaelmardojai/firefox-gnome-theme/ && cd firefox-gnome-theme
``` ```
2. Run installation script
2. Run installation script: #### Auto install script
This script will lookup Firefox profiles location and enable a theme variant for your GTK theme if it exists.
```sh
./scripts/auto-install.sh
```
#### Install script
```sh ```sh
./scripts/install.sh # Standard ./scripts/install.sh # Standard
./scripts/install.sh -f ~/.var/app/org.mozilla.firefox/.mozilla/firefox # Flatpak ./scripts/install.sh -f ~/.var/app/org.mozilla.firefox/.mozilla/firefox # Flatpak
``` ```
#### 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/`
- `-p <profile_name>` *optional* - `-p <profile_name>` *optional*
- Set custom profile name, for example `e0j6yb0p.default-nightly`. - Set custom profile name, for example `e0j6yb0p.default-nightly`.
- Default: standard default profile - Default: standard default profile
- `-t <theme_name>` *optional* - `-t <theme_name>` *optional*
- Set the colors used in the theme. - Set the colors used in the theme.
- Default: Adwaita. - Default: Adwaita.
- Options: `adwaita`, `maia`, `yaru`. - Options: `adwaita`, `maia`, `yaru`.
### One command curled script ### One command curled script
You can also install this theme with one command: You can also install this theme with one command:
`curl -s -o- https://raw.githubusercontent.com/rafaelmardojai/firefox-gnome-theme/master/scripts/install-by-curl.sh | bash` ```sh
curl -s -o- https://raw.githubusercontent.com/rafaelmardojai/firefox-gnome-theme/master/scripts/install-by-curl.sh | bash
```
It will download the latest version of the theme and run the installation script for you. It will download the latest version of the theme and run the installation script for you.
@ -93,7 +103,8 @@ It will download the latest version of the theme and run the installation script
8. Symlink preferences file: 8. Symlink preferences file:
```sh ```sh
ln -s chrome/firefox-gnome-theme/configuration/user.js ../user.js cd .. # Go back to the profile directory
ln -fs chrome/firefox-gnome-theme/configuration/user.js user.js
``` ```
9. Restart Firefox. 9. Restart Firefox.