diff --git a/README.md b/README.md index a9dd2ed..6fa0789 100644 --- a/README.md +++ b/README.md @@ -2,33 +2,6 @@ A fast, simple command-line tool to search man pages by keyword, written in Zig. -## Features - -- **Fast keyword search** using `man -k` (apropos) -- **Section filtering** to search specific man page sections (1-9) -- **Path resolution** to show actual file locations -- **Verbose mode** with timing information -- **POSIX compatible** - works on Linux and macOS -- **Simple and reliable** - no complex dependencies - -## Project Structure - -The project is organized into logical modules for maintainability: - -``` -src/ -├── main.zig # Main program entry point -├── types.zig # Data structures and types -├── parser.zig # Command line argument parsing -└── search.zig # Man page search functionality -``` - -### Module Responsibilities - -- **`types.zig`**: Contains `ManEntry`, `ManEntryList`, and `SearchConfig` structures -- **`parser.zig`**: Handles command line argument parsing, validation, and help text -- **`search.zig`**: Manages man page searching and keyword matching - ## Usage ### Basic Search