summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorKyohei Uto <im@kyoheiu.dev>2022-12-12 06:17:58 +0900
committerKyohei Uto <im@kyoheiu.dev>2022-12-12 06:17:58 +0900
commitd5b0fe5ebbb8063e784b3f6a6f202ea34afc74ba (patch)
treeecbd4ab35eb4a6f0b9acc1b871322ab243c99112 /README.md
parentd87597f1a454fa533f468c551607910883a32f6f (diff)
Update documents
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 8 insertions, 4 deletions
diff --git a/README.md b/README.md
index 0070b76..33278e4 100644
--- a/README.md
+++ b/README.md
@@ -2,10 +2,11 @@
# _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 the detailed document, please see https://kyoheiu.dev/felix.
+For an overview of this app, please see this README, especially [key manual](#key).
+For more detailed document, visit https://kyoheiu.dev/felix.
![sample](screenshots/sample.gif)
@@ -17,7 +18,8 @@ For the detailed document, please see https://kyoheiu.dev/felix.
- **IMPORTANT**: Trash and log directory path changed.
- from v2.2.0, felix will use `dirs::data_local_dir()` to store the deleted items and log files, instead of `dirs::config_dir()`.
- - Due to this change, the path for linux will be `$XDG_DATA_HOME/felix/{Trash, log}`, in most case `/home/user/.local/share/felix/{Trash, log}`. For Windows `{FOLDERID_LocalAppData}\felix\{Trash, log}`, in most case `C:\Users\user\AppData\Local\felix\{Trash, log}`. No change for macOS users. Note that config file path is not changed!
+ - Due to this change, the path for linux will be `$XDG_DATA_HOME/felix/{Trash, log}`, in most case `/home/user/.local/share/felix/{Trash, log}`. For Windows `{FOLDERID_LocalAppData}\felix\{Trash, log}`, typically `C:\Users\user\AppData\Local\felix\{Trash, log}`. No change for macOS users.
+ - Note that config file path is unchanged for any OS!
- Please don't forget deleting old trash diretory and log files if you don't want them anymore.
### Added
@@ -69,7 +71,7 @@ yay -S felix-rs
### NetBSD
-available from the official repositories:
+Available from the official repositories.
```
pkgin install felix
@@ -108,6 +110,8 @@ Both relative and absolute path available.
`-l [path]` | `--log [path]` => Launch the app and create a log file.
```
+<a id="key"></a>
+
## Key Manual
```