docs: reorder README sections — screenshots before build, font after installation
This commit is contained in:
parent
c2ca689814
commit
68f340ee7d
1 changed files with 58 additions and 58 deletions
116
README.md
116
README.md
|
|
@ -9,6 +9,64 @@
|
||||||
- Asynchronous copy/move with progress and background mode
|
- Asynchronous copy/move with progress and background mode
|
||||||
- Theme support and configurable layout/columns
|
- Theme support and configurable layout/columns
|
||||||
|
|
||||||
|
## Screenshots
|
||||||
|
|
||||||
|

|
||||||
|

|
||||||
|

|
||||||
|
|
||||||
|
## Build and run
|
||||||
|
|
||||||
|
Run directly:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
go run ./cmd/vcom
|
||||||
|
```
|
||||||
|
|
||||||
|
Build local binary:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
go build -o vcom ./cmd/vcom
|
||||||
|
```
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
### NixOS / Nix
|
||||||
|
|
||||||
|
Run directly from the flake:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
nix run github:vrubelroman/vcom?ref=v0.1.9
|
||||||
|
```
|
||||||
|
|
||||||
|
Install into user profile:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
nix profile add github:vrubelroman/vcom?ref=v0.1.9
|
||||||
|
```
|
||||||
|
|
||||||
|
The Nix package wraps `vcom` with `ueberzugpp` in `PATH`, so image preview works in non-`kitty` terminals out of the box.
|
||||||
|
|
||||||
|
### Debian / Ubuntu
|
||||||
|
|
||||||
|
Download the release `.deb` for `v0.1.9`, then install:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo apt install ./vcom_0.1.9_amd64.deb
|
||||||
|
```
|
||||||
|
|
||||||
|
The Debian package declares `ueberzug` (or `ueberzugpp` where available) as a dependency for image preview outside `kitty`.
|
||||||
|
|
||||||
|
### Arch Linux
|
||||||
|
|
||||||
|
A `PKGBUILD` is included in the repository:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
makepkg -si
|
||||||
|
```
|
||||||
|
|
||||||
|
The Arch package depends on `ueberzugpp`, so non-`kitty` image preview is installed together with `vcom`.
|
||||||
|
|
||||||
## Font requirement (icons)
|
## Font requirement (icons)
|
||||||
|
|
||||||
For file icons, `vcom` expects a Nerd Font in your terminal profile.
|
For file icons, `vcom` expects a Nerd Font in your terminal profile.
|
||||||
|
|
@ -79,64 +137,6 @@ Preview mode (`F9` / `i`) temporarily replaces the inactive pane and shows:
|
||||||
- image metadata (format + dimensions)
|
- image metadata (format + dimensions)
|
||||||
- safe fallback for binary files
|
- safe fallback for binary files
|
||||||
|
|
||||||
## Screenshots
|
|
||||||
|
|
||||||

|
|
||||||

|
|
||||||

|
|
||||||
|
|
||||||
## Build and run
|
|
||||||
|
|
||||||
Run directly:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
go run ./cmd/vcom
|
|
||||||
```
|
|
||||||
|
|
||||||
Build local binary:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
go build -o vcom ./cmd/vcom
|
|
||||||
```
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
### NixOS / Nix
|
|
||||||
|
|
||||||
Run directly from the flake:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
nix run github:vrubelroman/vcom?ref=v0.1.9
|
|
||||||
```
|
|
||||||
|
|
||||||
Install into user profile:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
nix profile add github:vrubelroman/vcom?ref=v0.1.9
|
|
||||||
```
|
|
||||||
|
|
||||||
The Nix package wraps `vcom` with `ueberzugpp` in `PATH`, so image preview works in non-`kitty` terminals out of the box.
|
|
||||||
|
|
||||||
### Debian / Ubuntu
|
|
||||||
|
|
||||||
Download the release `.deb` for `v0.1.9`, then install:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
sudo apt install ./vcom_0.1.9_amd64.deb
|
|
||||||
```
|
|
||||||
|
|
||||||
The Debian package declares `ueberzug` (or `ueberzugpp` where available) as a dependency for image preview outside `kitty`.
|
|
||||||
|
|
||||||
### Arch Linux
|
|
||||||
|
|
||||||
A `PKGBUILD` is included in the repository:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
makepkg -si
|
|
||||||
```
|
|
||||||
|
|
||||||
The Arch package depends on `ueberzugpp`, so non-`kitty` image preview is installed together with `vcom`.
|
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
Optional config lookup order:
|
Optional config lookup order:
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue