From 68f340ee7d7704e5e160fca7c40b4dea867fb8f1 Mon Sep 17 00:00:00 2001 From: vrubelroman Date: Mon, 27 Apr 2026 16:13:47 +0300 Subject: [PATCH] =?UTF-8?q?docs:=20reorder=20README=20sections=20=E2=80=94?= =?UTF-8?q?=20screenshots=20before=20build,=20font=20after=20installation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 116 +++++++++++++++++++++++++++--------------------------- 1 file changed, 58 insertions(+), 58 deletions(-) diff --git a/README.md b/README.md index 87dad9f..ec5b652 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,64 @@ - Asynchronous copy/move with progress and background mode - Theme support and configurable layout/columns +## Screenshots + +![vcom screenshot](docs/screen.png) +![vcom screenshot 2](docs/screen2.png) +![vcom screenshot 3](docs/screen3.png) + +## 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) 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) - safe fallback for binary files -## Screenshots - -![vcom screenshot](docs/screen.png) -![vcom screenshot 2](docs/screen2.png) -![vcom screenshot 3](docs/screen3.png) - -## 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 Optional config lookup order: