https://github.com/awinterman/hungry

A Better Documentation Display System
https://github.com/awinterman/hungry

Last synced: 4 months ago
JSON representation

A Better Documentation Display System

• Host: GitHub
• URL: https://github.com/awinterman/hungry
• Owner: AWinterman
• Created: 2013-04-17T22:07:01.000Z (about 13 years ago)
• Default Branch: master
• Last Pushed: 2013-04-17T22:22:50.000Z (about 13 years ago)
• Last Synced: 2025-03-01T06:27:00.123Z (over 1 year ago)
• Size: 102 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Hungry 

Hungry provides a two column view of code and documentation. It will

turn any definition that refers to a function in another file into a link to

that file and it's accompanying documentation.

Hungry Supports both inline documentation, and mirrored directory structured

documentation. 

Should be a commandline service that renders a directory and all of it's

subdirectories. You can include a .hun-ignore file in your project root which

will prevent Hungry from traversing the listed files and directories.

The documentation website will be in the `hun-doc` directory. It also includes

a configurable hook so that any time you commit (whether in `hg`, `git`, etc.)

it will run. May be better to run on push, since commits should stay light

weight.