Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
leo-arch authored Jan 2, 2023
1 parent 485d5e6 commit 4291bbc
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# clifm-colors
> Extra color schemes for the [CliFM file manager](https://github.com/leo-arch/clifm)
> Extra color schemes for the [**clifm** file manager](https://github.com/leo-arch/clifm)
[![clifm-colors-git](https://img.shields.io/aur/version/clifm-colors-git?color=1793d1&label=clifm-colors-git&logo=archlinux&style=flat)](https://aur.archlinux.org/packages/clifm-colors-git)
[![License](https://img.shields.io/github/license/leo-arch/clifm?color=green&style=flat)](https://github.com/leo-arch/clifm/blob/master/LICENSE)
Expand All @@ -8,7 +8,7 @@

## Table of contents
[Themes list](#themes-list) \
[Screenshots](#screenshots) \
[Screenshots](#some-screenshots) \
[Installation](#installation) \
[License](#license) \
[Constributing](#contributing) \
Expand All @@ -29,7 +29,7 @@
- [x] white-256
- [x] white

## Screenshots
## Some screenshots

### Amber-256
![clifm](screenshots/amber-256.png)
Expand All @@ -49,26 +49,28 @@

#### 1.a For Archlinux users:

Install the package (it is available on the [AUR](https://aur.archlinux.org/packages/clifm-colors-git)). Color schemes are installed in `$XDG_DATA_DIRS/clifm/colors` (usually `/usr/share/clifm/colors`).
Install the package (it is available in the [AUR](https://aur.archlinux.org/packages/clifm-colors-git)). Color schemes are installed in `$XDG_DATA_DIRS/clifm/colors` (usually `/usr/share/clifm/colors`).

#### 1.b If not using Arch:

a) Clone this repo:

git clone https://github.com/leo-arch/clifm-colors
```sh
git clone https://github.com/leo-arch/clifm-colors
```

b) cd into the colors directory and copy the color schemes (`.clifm` files) into the colors directory of your _CliFM_ local directory (`$XDG_CONFIG_HOME/clifm/colors` or `$HOME/.config/clifm/colors`).
b) cd into the `colors` directory and copy the color schemes (`.clifm` files) into the colors directory of your **clifm** local directory (`$XDG_CONFIG_HOME/clifm/colors` or `$HOME/.config/clifm/colors`).

#### 2. Set your theme
Once the theme is copied, set the desired color scheme, either via command line (with the `--color-scheme` option) or, once in _CliFM_, with the `cs` command. You can also permanently set the color scheme using the main configuration file: `clifmrc` (which can be accessed via the `edit` command or pressing <kbd>F10</kbd>).
Once the theme is copied, set the desired color scheme, either via the command line (with the `--color-scheme` option) or, once in **clifm**, with the `cs` command. You can also permanently set the color scheme using the main configuration file: `clifmrc` (which can be accessed via the `edit` command or pressing <kbd>F10</kbd>).

**Note**: If using a version of _CliFM_ prior to 1.6.1, the extension of the color theme files must be changed from `.clifm` to `.cfm`. Follow [this link](https://github.com/leo-arch/clifm/wiki/Specifics#new-extension-for-configuration-files) for more details on this issue.
**Note**: If using a version of **clifm** prior to 1.6.1, the extension of the color theme files must be changed from `.clifm` to `.cfm`. Follow [this link](https://github.com/leo-arch/clifm/wiki/Specifics#new-extension-for-configuration-files) for more details on this issue.

---

## Creating new themes

You can create modified/custom versions of these color schemes by copying them into the appropriate directory and editing them to your liking via a simple text editor. For more detailed information consult the [_CliFM_ Wiki](https://github.com/leo-arch/clifm/wiki/Customization#colors).
You can create modified/custom versions of these color schemes by copying them into the appropriate directory and editing them to your liking via a simple text editor. For more detailed information consult the [**clifm** wiki](https://github.com/leo-arch/clifm/wiki/Customization#colors).

---

Expand All @@ -84,5 +86,5 @@ Yes. Try these color schemes, modify them, and even create your own themes. If y
---

## Community
Join CliFM's [Gitter discussion room](https://gitter.im/leo-arch/clifm) and let us know what you think: ideas, comments, observations and questions are always welcome. \
The [Discussions](https://github.com/leo-arch/clifm/discussions) section of _CliFM_ is also open to input.
Join **clifm**'s [Gitter discussion room](https://gitter.im/leo-arch/clifm) and let us know what you think: ideas, comments, observations and questions are always welcome. \
The [Discussions](https://github.com/leo-arch/clifm/discussions) section of **clifm** is also open to input.

0 comments on commit 4291bbc

Please sign in to comment.