Skip to content

Commit 35f3051

Browse files
author
Sean Patrick
committed
Merge branch 'main' of github.com:seanap/fzd
2 parents 1c23f80 + eb9c501 commit 35f3051

2 files changed

Lines changed: 23 additions & 44 deletions

File tree

README.md

Lines changed: 5 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -34,34 +34,13 @@ Open a new shell (or source ~/.zshrc) and run:
3434

3535
If you want to tweak the search roots/excludes later, edit `~/.fzd/fzd.conf`.
3636

37-
Config
37+
## Config
3838
Edit ~/.fzd/fzd.conf (installed from share/fzd.conf.example).
3939

40-
Requirements (Ubuntu/WSL)
41-
fzf (>=0.50), fd/fdfind, bat/batcat, eza, tree, file, micro, plocate.
4240

43-
Installer handles these; see docs/REQUIREMENTS.md for details and WSL tips.
41+
## REQUIREMENTS
4442

45-
Uninstall
46-
bash
47-
Copy
48-
Edit
49-
~/.fzd/fzd.sh --help # (soon)
50-
./uninstall.sh
51-
MIT © You
52-
53-
perl
54-
Copy
55-
Edit
56-
57-
---
58-
59-
## 7) `docs/REQUIREMENTS.md` (focused)
60-
61-
```markdown
62-
# fzd requirements & setup notes
63-
64-
## Core tools
43+
### Core tools
6544
- **fzf ≥ 0.50** – we rely on `start:pos(N)` (caret preselect)
6645
- **fd** (or `fdfind` on Ubuntu) – fast filesystem listing for cache mode
6746
- **plocate** – global search backend; we call `locate -i -e -l N QUERY`
@@ -70,14 +49,14 @@ Edit
7049
- **micro** (or `$EDITOR`) – used when pressing Enter on files
7150
- `tree`, `file`, `hexdump` – fallbacks/extra info
7251

73-
## WSL / locate tuning
52+
### WSL / locate tuning
7453
- Avoid indexing Windows mounts for speed/stability:
7554
- `sudo cp /etc/updatedb.conf /etc/updatedb.conf.bak`
7655
- Ensure `/mnt` appears in `PRUNEPATHS`, and `PRUNE_BIND_MOUNTS = yes`
7756
- `sudo updatedb`
7857
- Keep `FZD_GLOBAL_PATHS` to Linux paths; exclude `/mnt` via `FZD_GLOBAL_XEXCLUDES`.
7958

80-
## Useful env vars (in `~/.fzd/fzd.conf`)
59+
### Useful env vars (in `~/.fzd/fzd.conf`)
8160
- `FZD_GLOBAL_BACKEND=locate|cache|auto`
8261
- `FZD_GLOBAL_PATHS="/ /etc /opt /srv /home/$USER"` (space-separated)
8362
- `FZD_GLOBAL_XEXCLUDES="proc,sys,dev,run,proc/*,sys/*,dev/*,run/*,mnt,..."`

docs/REQUIREMENTS.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -26,24 +26,24 @@
2626

2727
## FZD files
2828

29-
fzd/
30-
├─ bin/
31-
│ └─ fzd.sh
32-
├─ share/
33-
│ └─ fzd.conf.example # editable defaults
34-
├─ shell/
35-
│ ├─ lf.zsh # `lf` function that runs fzd then cd's
36-
│ └─ fzd.zsh # hotkey widget
37-
├─ install.sh # one-shot installer (Ubuntu/WSL-first)
38-
├─ uninstall.sh # clean removal
39-
├─ README.md
40-
├─ docs/
41-
│ └─ REQUIREMENTS.md
42-
├─ .editorconfig
43-
├─ .gitignore
44-
├─ LICENSE # MIT
45-
└─ .github/workflows/
46-
└─ shellcheck.yml # CI lint
29+
fzd/
30+
├─ bin/
31+
│ └─ fzd.sh
32+
├─ share/
33+
│ └─ fzd.conf.example # editable defaults
34+
├─ shell/
35+
│ ├─ lf.zsh # `lf` function that runs fzd then cd's
36+
│ └─ fzd.zsh # hotkey widget
37+
├─ install.sh # one-shot installer (Ubuntu/WSL-first)
38+
├─ uninstall.sh # clean removal
39+
├─ README.md
40+
├─ docs/
41+
│ └─ REQUIREMENTS.md
42+
├─ .editorconfig
43+
├─ .gitignore
44+
├─ LICENSE # MIT
45+
└─ .github/workflows/
46+
└─ shellcheck.yml # CI lint
4747

4848

4949
## Defaults we set

0 commit comments

Comments
 (0)