Browse Source

Clarify recommended configuration.

master
Mathieu Laparie 1 year ago
parent
commit
009167cfc4
1 changed files with 15 additions and 6 deletions
  1. 15
    6
      README.md

+ 15
- 6
README.md View File

@@ -33,19 +33,19 @@ The two underlying scripts, `rofiemoji.sh` and `rofiunicode.sh`, will try to dow
cp $HOME/.config/rofiemoji-rofiunicode/sidetab-adapta.rasi $HOME/.local/share/rofi/themes/
```

3. If step 2 was completed, add a custom keybinding using your window-manager settings for the following command:
3. **If step 2 was completed**, add a custom keybinding using your window-manager settings for the following command:

```sh
rofi -show windowcd -theme-str '#window{width: 30%;}' # See the rofi documentation for details
```

Alternatively, if step 2 was skipped, use a command containing at least the following arguments:
3. **If step 2 was skipped**, use a command containing at least the following arguments:

```sh
rofi -show unicode -modi 'unicode:~/.config/rofiemoji-rofiunicode/rofiunicode.sh,emoji:~/.config/rofiemoji-rofiunicode/rofiemoji.sh' -theme-str '#window{width: 30%;}'
```
```

## Usage example
## Usage

1. Invoke rofi using the keybinding you set and navigate through tabs using `Ctrl+Tab` (default).

@@ -54,19 +54,28 @@ The two underlying scripts, `rofiemoji.sh` and `rofiunicode.sh`, will try to dow
## Recommended configuration
Users who already configured rofi to their own taste before may prefer to skip installation step 2 to keep their custom changes.

However, for users new to rofi, applying the recommended configuration (installation step 2) should facilitate the setup by configuring everything as in the screenshots above. This will move/rename the supplied `config.example` file and the `sidetab-adapta.rasi` theme (originally taken from the [davatorium/**rofi-themes**](https://raw.githubusercontent.com/davatorium/rofi-themes/master/User%20Themes/sidetab-adapta.rasi) collection) into the adequate folders.
However, for users new to rofi, applying the recommended configuration (installation step 2) should facilitate the setup by configuring everything as in the screenshots. This will move/rename the supplied `config.example` file and the `sidetab-adapta.rasi` theme (originally taken from the [davatorium/**rofi-themes**](https://raw.githubusercontent.com/davatorium/rofi-themes/master/User%20Themes/sidetab-adapta.rasi) collection) into the adequate folders.

| Make sure you review `config.example` to check if custom changes will work on your machine. While most of them should be system-agnostic, some settings are tailored to my own use or preferences and may not work on all systems. |
| --- |

For instance, the supplied `config.example` file makes rofi work with gnome-terminal, but default rofi values might work better when using other terminals. In the latter case, it is best to edit `config.example` before installation step 2, or `~/.config/rofi/config` after step 2, to add `!` at the beginning of the following lines to disable them and restore the defaults:
For instance, the supplied `config.example` file makes rofi work with gnome-terminal, but default rofi values might work better when using other terminals. In the latter case, it is best to edit `config.example` before installation step 2 (or `~/.config/rofi/config` after step 2) to update it according to your specific system requirements, or simply to disable each of the following lines by prepending them with `!`:

Before:
```sh
rofi.terminal: gnome-terminal
rofi.ssh-command: {terminal} -- {ssh-client} {host}
rofi.run-shell-command: {terminal} -- bash -c "{cmd}; bash"
```

After:

```sh
! rofi.terminal: gnome-terminal
! rofi.ssh-command: {terminal} -- {ssh-client} {host}
! rofi.run-shell-command: {terminal} -- bash -c "{cmd}; bash"
```

## Alternative emoji- and unicode-picker

[kabouik/**rofimoji**](https://github.com/Kabouik/rofimoji) is an alternative based on the original [fdw/**rofimoji**](https://github.com/fdw/rofimoji) instead of the [nkoehring/**rofiemoji**](https://github.com/nkoehring/rofiemoji) script version, but still with the addition of unicode characters. It allows multiple selection of emojis or unicode characters, as well as direct input without prior clipboard step, but the customization possibilities are more limited and there is no visual unification with your main rofi instance.

Loading…
Cancel
Save