From 274a0e0deb1ea4315dfacf4b9665ee268f22c7df Mon Sep 17 00:00:00 2001 From: Brook J Date: Fri, 24 May 2024 21:46:25 +1000 Subject: [PATCH] re-arrange readme --- README.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 8097f7c..2beb02c 100644 --- a/README.md +++ b/README.md @@ -16,21 +16,15 @@ - **File Previews**: Preview contents of files directly in the terminal. - **Configurable Options**: Customize settings via an external configuration file. -## Roadmap -- Keybindings for Common Actions: - - Delete files - - Duplicate files - - Copy files - - Adjust settings -- Open Files in Editor -- Customizable keybinds -- Fuzzy search files -- Syntax highlighting - ## Install To install zfe, check the "Releases" section in Github and download the appropriate version or build locally via `zig build run`. +## Configuration +Configure `zfe` by editing the external configuration file located at either: +- `$HOME/.zfe/config.json` +- `$XDG_CONFIG_HOME/zfe/config.json`. + ## Keybinds ``` j / :Go down. @@ -42,11 +36,17 @@ G :Go to the bottom. q / :Exit. ``` -### Contributing +## Roadmap +- Keybindings for Common Actions: + - Delete files + - Duplicate files + - Copy files + - Adjust settings +- Open Files in Editor +- Customizable keybinds +- Fuzzy search files +- Syntax highlighting + +## Contributing Contributions, issues, and feature requests are always welcome! This project is currently using the latest stable release of Zig (0.12.0). - -## Configuration -Configure `zfe` by editing the external configuration file located at either: -- `$HOME/.zfe/config.json` -- `$XDG_CONFIG_HOME/zfe/config.json`.