Home Directory / Slit
Slit is a literate programming tool. Literate programming is a particular approach to programming introduced by Donald Knuth. For a introduction you can read the wikipedia article for Literate Programming.
To keep a long story short in literate programming you reverse the relation between code and documentation: usually you write commented code (you comment your code, right?); with literate programming you write your code in the documentation.
Just to clarify your ideas let's show a simple flow-chart:
As you see in the diagram you write a documentation file (documentation can obviously span to multiple files) and Slit will generate for you the documentation and the source code of your program.
When you are writing you can expose the code in the format you need for explaining the functionalities and then compose it in multiple source files using the Slit directives.
Let's see a simple example just to fix ideas:
This little literate program will generate a "main.c" file like this:
Slit can be used with Linux and with Windows. You can generate documentation in multiple formats such as:
Slit is released under GPL license and you can download and view it's code and documentation here at BitBucket
Thanks to all!
You can concact the author via e-mail: leonardoNOSPAMce@interfree.it (please remove NOSPAM from the email address)