Skip to content

Commit

Permalink
re-arrange readme
Browse files Browse the repository at this point in the history
  • Loading branch information
BrookJeynes committed May 24, 2024
1 parent 36699f1 commit 274a0e0
Showing 1 changed file with 17 additions and 17 deletions.
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 / <Down> :Go down.
Expand All @@ -42,11 +36,17 @@ G :Go to the bottom.
q / <CTRL-c> :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`.

0 comments on commit 274a0e0

Please sign in to comment.