Skip to content

Commit

Permalink
Add description for configuration file
Browse files Browse the repository at this point in the history
Signed-off-by: Artem Senichev <[email protected]>
  • Loading branch information
artemsen committed Nov 20, 2021
1 parent 13a6ebf commit 201d583
Showing 1 changed file with 16 additions and 5 deletions.
21 changes: 16 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,26 @@ Hex editor with ncurses based user interface:

![Screenshot](https://raw.githubusercontent.com/artemsen/xvi/master/.github/screenshot2.png)

## Install

- Arch users can install the program via [AUR](https://aur.archlinux.org/packages/xvi-git);
- AppImage is available in [Releases](https://github.com/artemsen/xvi/releases).

## Configure

The editor searches for the configuration file with name `config` in the
following directories:
- `$XDG_CONFIG_HOME/xvi`
- `$HOME/.config/xvi`

Sample file is available [here](https://github.com/artemsen/xvi/blob/master/extra/xvirc).

See `man xvirc` for details.

## Build

The project uses Rust and Cargo:

```
cargo build --release
```

## Install

- Arch users can install the program via [AUR](https://aur.archlinux.org/packages/xvi-git);
- AppImage is available in [Releases](https://github.com/artemsen/xvi/releases).

0 comments on commit 201d583

Please sign in to comment.