Project

codnar

0.01
No commit activity in last 3 years
No release in over 3 years
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.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

>= 0
>= 0
>= 0
>= 0
>= 0
>= 0
>= 0
>= 0

Runtime

 Project Readme

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)