Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Code Narrator - an inverse literate programming tool.

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 .codnar-cache
Octocat-spinner-32 bin
Octocat-spinner-32 doc
Octocat-spinner-32 lib
Octocat-spinner-32 test
Octocat-spinner-32 .gitignore
Octocat-spinner-32 ChangeLog
Octocat-spinner-32 LICENSE
Octocat-spinner-32 README.rdoc
Octocat-spinner-32 Rakefile
Octocat-spinner-32 codnar.html
Octocat-spinner-32 exceptions.reek
Octocat-spinner-32 roodi.config
README.rdoc

Codnar

Code Narrator - an inverse literate programming tool.

TL;DR

Description

Code Narrator (Codnar) is an inverse literate programming tool. It splits the source files into “chunks” (including structured comments) and weaves them back into a narrative that describes the overall system.

Installation

A simple gem install codnar should do the trick, assuming you have Ruby gems set up. If you want to use the VIM-based syntax highlighting, you also need to install gvim. Similarly, you need to install GraphViz to be able to embed SVG diagrams in your HTML.

Usage

The basic usage is:

codnar-split [options] source-file > chunks-file
codnar-weave [options] chunks-files... > codnar.html

Both programs accept a -h or --help flag to print more detailed usage messages. You can also invoke Codnar from a Rakefile:

require "codnar/rake"

Codnar::Rake::SplitTask([ source-files... ], [ configurations... ])
Codnar::Rake::WeaveTask(root-file, [ configurations... ], output)
Something went wrong with that request. Please try again.