summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorKyohei Uto <im@kyoheiu.dev>2023-04-24 05:00:11 +0900
committerKyohei Uto <im@kyoheiu.dev>2023-04-24 05:00:11 +0900
commitd1850474472760f07a8706e7eb5138b5395ddf96 (patch)
treea97cfdb18beedfd44b5e6b73dadaaec568e8a2e1 /README.md
parentf2a868fe4c2cac8d067f53f3612ab231aff60f21 (diff)
v2.2.6: Remove duplicated -v option
Diffstat (limited to 'README.md')
-rw-r--r--README.md72
1 files changed, 36 insertions, 36 deletions
diff --git a/README.md b/README.md
index 536ddf4..393a908 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,14 @@
-[![crates.io](https://img.shields.io/crates/v/felix)](https://crates.io/crates/felix) ![arch linux](https://img.shields.io/archlinux/v/community/x86_64/felix-rs) ![MSRV](https://img.shields.io/badge/MSRV-1.60.0-orange)
+[![crates.io](https://img.shields.io/crates/v/felix)](https://crates.io/crates/felix)
+![arch linux](https://img.shields.io/archlinux/v/community/x86_64/felix-rs)
+![MSRV](https://img.shields.io/badge/MSRV-1.60.0-orange)
# _felix_
-A tui file manager with Vim-like key mapping, written in Rust.
+A tui file manager with Vim-like key mapping, written in Rust.\
Fast, simple, and easy to configure & use.
-For an overview of this app, take a look at this README, especially [key manual](#key-manual).
+For an overview of this app, take a look at this README, especially
+[key manual](#key-manual).\
For more detailed document, visit https://kyoheiu.dev/felix.
- [New release](#new-release)
@@ -23,9 +26,19 @@ For more detailed document, visit https://kyoheiu.dev/felix.
## New release
+## v2.2.6 (2023-04-24)
+
+### Removed
+
+- Remove duplicated `-v | --version` option. This is because i) Since some users
+ do not have `cargo` installed, fetching latest version via `cargo` doesn't
+ work for many, and ii) `-h | --help` option can already show the current
+ version.
+
## v2.2.5 (2023-02-12)
### Added
+
- Allow renaming even when item name contains non-ascii chars (i.e. wide chars).
- Key command with arguments is now supported: For example,
```
@@ -33,10 +46,12 @@ For more detailed document, visit https://kyoheiu.dev/felix.
'feh -.':
[jpg, jpeg, png, gif, svg, hdr]
```
- this configuration enables you to execute `feh -. <item path>` by `Enter | l | Right`, or `o`.
+ this configuration enables you to execute `feh -. <item path>` by
+ `Enter | l | Right`, or `o`.
- Check for out-of-boundary of the cursor at the top of loop.
### Fixed
+
- Display when using in kitty: Correctly show the cursor and preview.
For more details, see `CHANGELOG.md`.
@@ -52,13 +67,21 @@ For more details, see `CHANGELOG.md`.
| MacOS | works |
| Windows | not fully tested yet |
-_For Windows users: From v1.3.0, it can be at least compiled on Windows (see `.github/workflows/install_test.yml`.) If you're interested, please try and report any problems._
+_For Windows users: From v1.3.0, it can be at least compiled on Windows (see
+`.github/workflows/install_test.yml`.) If you're interested, please try and
+report any problems._
<a id="installation"></a>
## Installation
-### Prerequisites
+| package | installation command | notes |
+| ---------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
+| crates.io | `cargo install felix` | |
+| Arch Linux | `pacman -S felix-rs` | The binary name is `felix` if you install via pacman. Alias `fx='felix'` if you want, as this document (and other installations) uses `fx`. |
+| NetBSD | `pkgin install felix` | |
+
+### From this repository
- Make sure that `gcc` is installed.
- MSRV(Minimum Supported rustc Version): **1.60.0**
@@ -69,31 +92,6 @@ Update Rust if rustc < 1.60:
rustup update
```
-### From crates.io
-
-```
-cargo install felix
-```
-
-### Arch Linux
-
-```
-pacman -S felix-rs
-```
-
-*The launcher binary name is `felix` via pacman.
-Alias fx='felix' if you want, as this document (and other installations) uses `fx`.*
-
-### NetBSD
-
-Available from the official repositories.
-
-```
-pkgin install felix
-```
-
-### From this repository
-
```
git clone https://github.com/kyoheiu/felix.git
cd felix
@@ -106,8 +104,11 @@ cargo install --path .
In addition, you can use felix more conveniently by installing these two apps:
-- [zoxide](https://github.com/ajeetdsouza/zoxide): A smarter `cd` command, which enables you to jump to a directory that matches the keyword in felix.
-- [chafa](https://hpjansson.org/chafa/): Terminal graphics for the 21st century, by which you can preview images in felix. ***chafa must be v1.10.0 or later.***
+- [zoxide](https://github.com/ajeetdsouza/zoxide): A smarter `cd` command, which
+ enables you to jump to a directory that matches the keyword in felix.
+- [chafa](https://hpjansson.org/chafa/): Terminal graphics for the 21st century,
+ by which you can preview images in felix. _**chafa must be v1.10.0 or
+ later.**_
These apps do not need any configuration to use with felix!
@@ -115,7 +116,7 @@ These apps do not need any configuration to use with felix!
## Usage
-*If you install this app via pacman, the default binary name is `felix`.*
+_If you install this app via pacman, the default binary name is `felix`._
```
`fx` => Show items in the current directory.
@@ -127,7 +128,6 @@ Both relative and absolute path available.
```
`-h` | `--help` => Print help.
-`-v` | `--version` => Check update.
`-l` | `--log` => Launch the app, automatically generating a log file in `{data_local_dir}/felix/log`.
```
@@ -179,7 +179,7 @@ Esc :Return to the normal mode.
## Preview feature
-By default, text files and directories can be previewed.
+By default, text files and directories can be previewed.\
Install `chafa` and you can preview images without any configuration.
<a id="configuration"></a>