Metadata-Version: 2.1
Name: cmakedoc
Version: 1.0.1
Summary: cmakedoc makes it easier to search CMake reference documentation.
Home-page: https://github.com/agateau/cmakedoc
Author: Aurélien Gâteau
Author-email: mail@agateau.com
License: Apache 2.0
Keywords: cmake doc development
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Build Tools
Description-Content-Type: text/markdown
License-File: COPYING

# 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
