https://github.com/agateau/cmakedoc

Command line tool to read cmake documentation
https://github.com/agateau/cmakedoc

Last synced: 10 months ago
JSON representation

Command line tool to read cmake documentation

• Host: GitHub
• URL: https://github.com/agateau/cmakedoc
• Owner: agateau
• License: apache-2.0
• Created: 2012-07-06T09:45:46.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2021-06-21T15:45:02.000Z (over 4 years ago)
• Last Synced: 2025-02-28T16:03:59.952Z (11 months ago)
• Language: Python
• Size: 1.89 MB
• Stars: 8
• Watchers: 5
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: COPYING

Awesome Lists containing this project

README

          
# 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`.

## Demo

![CMakedoc demonstration](demo.gif)

## Dependencies

- `cmake` (obviously). Must be in `$PATH`.

- `less`, or a pager defined in `$PAGER`.

## Installation

Using pip:

    pip install cmakedoc

Manually:

    ./setup.py install