@@ -2,13 +2,27 @@ |
| 2 | 2 | |
| 3 | 3 | A command-line file explorer written in modern Fortran with fzf integration. |
| 4 | 4 | |
| 5 | | -## Quick Start |
| 5 | +## Installation |
| 6 | 6 | |
| 7 | | -### Prerequisites |
| 7 | +### From AUR (Arch Linux) |
| 8 | + |
| 9 | +```bash |
| 10 | +yay -S fortress |
| 11 | +# or |
| 12 | +paru -S fortress |
| 13 | +``` |
| 14 | + |
| 15 | +Shell integration is automatically set up for bash and fish. Zsh users need to add to `~/.zshrc`: |
| 16 | +```bash |
| 17 | +source /usr/share/fortress/fortress.sh |
| 18 | +``` |
| 19 | + |
| 20 | +### From Source |
| 21 | + |
| 22 | +#### Prerequisites |
| 8 | 23 | |
| 9 | 24 | - gfortran 10+ or ifort |
| 10 | 25 | - fpm (Fortran Package Manager) |
| 11 | | -- fzf (for fuzzy finding features) |
| 12 | 26 | |
| 13 | 27 | ### Install fpm |
| 14 | 28 | |
@@ -33,6 +47,20 @@ fpm run |
| 33 | 47 | fpm run --flag "-O2" |
| 34 | 48 | ``` |
| 35 | 49 | |
| 50 | +### Shell Integration (Optional) |
| 51 | + |
| 52 | +To enable the "cd on exit" feature (press 'c' to navigate your shell to a directory): |
| 53 | + |
| 54 | +```bash |
| 55 | +# Add to your .bashrc or .zshrc: |
| 56 | +source /path/to/fortress/fortress.sh |
| 57 | + |
| 58 | +# Then use: |
| 59 | +fortress # instead of 'fpm run' |
| 60 | +``` |
| 61 | + |
| 62 | +This allows you to navigate to directories and have your shell follow when you press 'c'. |
| 63 | + |
| 36 | 64 | ### Development |
| 37 | 65 | |
| 38 | 66 | ```bash |
@@ -49,11 +77,15 @@ fpm build --flag "-g -Wall -Wextra" |
| 49 | 77 | - ✅ **Real filesystem navigation** with directory reading |
| 50 | 78 | - ✅ **Smart selection memory** - remembers position when navigating |
| 51 | 79 | - ✅ **Visual hierarchy** - dimmed parent pane, active current pane |
| 80 | +- ✅ **Color-coded files**: |
| 81 | + - Directories: Blue + bold |
| 82 | + - Executable files: Green |
| 83 | + - Dotfiles: Grey |
| 84 | + - Regular files: White |
| 52 | 85 | - ✅ **Smooth updates** - no flashing, selective redraws |
| 53 | | -- ✅ **Arrow key and vim-style navigation** (h,j,k,l) |
| 54 | | -- ✅ **Directory visualization** with color coding (blue with `/` suffix) |
| 86 | +- ✅ **Arrow key navigation** for intuitive movement |
| 55 | 87 | - ✅ **Full-width selection bar** - clean highlighting |
| 56 | | -- ✅ **Navigate directories** - enter/exit with arrow keys |
| 88 | +- ✅ **CD on exit** - press 'c' to navigate your shell to selected directory |
| 57 | 89 | |
| 58 | 90 | ## Next Steps |
| 59 | 91 | |
@@ -68,19 +100,25 @@ See [ROADMAP.md](ROADMAP.md) for detailed development plans. |
| 68 | 100 | |
| 69 | 101 | ## Controls |
| 70 | 102 | |
| 71 | | -- `↑/↓` or `j/k`: Navigate files |
| 72 | | -- `←/→` or `h/l`: Navigate directories |
| 73 | | -- `Enter`: Open file/enter directory |
| 74 | | -- `q` or `Ctrl-Q`: Quit |
| 103 | +- `↑/↓`: Navigate up/down |
| 104 | +- `→`: Enter directory |
| 105 | +- `←`: Go back to parent directory |
| 106 | +- `c`: CD to selected directory and exit (requires shell integration) |
| 107 | +- `q`: Quit |
| 75 | 108 | |
| 76 | 109 | ## Architecture |
| 77 | 110 | |
| 78 | | -FORTRESS is built with modular design: |
| 111 | +FORTRESS is built as a self-contained file explorer: |
| 112 | + |
| 113 | +- `app/main.f90`: Main application with integrated UI and file operations |
| 114 | +- `lib_modules/`: Modular components (available for future expansion) |
| 115 | + - `filesystem/`: File operations and directory walking |
| 116 | + - `terminal/`: Terminal I/O and screen management |
| 117 | + - `ui/`: User interface components (panes, rendering) |
| 118 | + |
| 119 | +## Packaging |
| 79 | 120 | |
| 80 | | -- `terminal/`: Terminal I/O and screen management |
| 81 | | -- `filesystem/`: File operations and directory walking |
| 82 | | -- `ui/`: User interface components (panes, rendering) |
| 83 | | -- `integration/`: External tool integration (fzf) |
| 121 | +For AUR maintainers, see [AUR_PACKAGING.md](AUR_PACKAGING.md) for complete packaging instructions. |
| 84 | 122 | |
| 85 | 123 | ## License |
| 86 | 124 | |