aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAkshay Nair <phenax5@gmail.com>2025-10-24 20:25:15 +0530
committerAkshay Nair <phenax5@gmail.com>2025-10-24 20:25:15 +0530
commitff0daf7c5edb92e9e2361e9985996725bade9a85 (patch)
treeeea01a125f94bd1169e12ee55b0ff4df365ef92c /README.md
parentcae48d231a82cd451658e3745ab23e1a2057d406 (diff)
downloaddaffm-ff0daf7c5edb92e9e2361e9985996725bade9a85.tar.gz
daffm-ff0daf7c5edb92e9e2361e9985996725bade9a85.zip
Add build/install setup + fix read error for move command
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 8 insertions, 3 deletions
diff --git a/README.md b/README.md
index 61d0cf1..cf9bb07 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,17 @@
# Daffm
Dumb as fuck file manager is a minimal tui file manager with the goal of not being a file manager.
At its core, it only provides a directory browser, providing ways to conviniently run shell commands to manage your files via keybinds and command line input.
-
![screenshot](./media/screenshot.jpg)
## Install
-- Clone the repo and build it: `cabal build daffm` or `nix build`
-- Nix flakes users can install it as a flake: `github:phenax/daffm#daffm`
+### Nix users
+- This repo can be installed as a nix flake: `github:phenax/daffm#daffm`
+- OR clone the repo and build it: `nix build`
+### Normals (requires cabal)
+- Clone the repo
+- `make install` to install it on your system (installs in `/usr/local` by default)
+- OR `make PREFIX=/install/path install` to install it inside `/install/path` directory
+- `make uninstall` to uninstall it
## Usage
Run `man daffm` to see the manual -> [./docs/daffm.md](./docs/daffm.md)