# CMakeDoc

## What is it?

CMakeDoc is a command-line tool to read CMake documentation. It lets you
search through CMake commands, modules, variables and properties before
displaying the selected topic with `less` or the pager defined in `$PAGER`.

## "Screenshot"

    user@host: cmakedoc pkg

    # Matching topics:
    1: FindPkgConfig (module)
    2: UsePkgConfig (module)

    Enter topic number or search term (empty input or 'q' to quit): 1

## Dependencies

- `cmake` (obviously). Must be in `$PATH`.
- `less`, or a pager defined in `$PAGER`.

## Installation

    ./setup.py install

# CMakeDoc

## What is it?

CMakeDoc is a command-line tool to read CMake documentation. It lets you
search through CMake commands, modules, variables and properties before
displaying the selected topic with `less` or the pager defined in `$PAGER`.

## "Screenshot"

    user@host: cmakedoc pkg

    # Matching topics:
    1: FindPkgConfig (module)
    2: UsePkgConfig (module)

    Enter topic number or search term (empty input or 'q' to quit): 1

## Dependencies

- `cmake` (obviously). Must be in `$PATH`.
- `less`, or a pager defined in `$PAGER`.

## Installation

Using pip:

    pip install cmakedoc

Manually:

    ./setup.py install

Add instructions to install with pip
Add instructions to install with pip
