README.txt in dokkit-0.3.0 vs README.txt in dokkit-0.4.0

- old
+ new

@@ -2,39 +2,59 @@ by Andrea Fazzi http://dokkit.rubyforge.org == DESCRIPTION: -dokkit is a document generator. It was inspired by rote but now -it is completely independent from it. dokkit uses -filters like deplate to generate output in a large variety of formats (tex, html, +dokkit is a document generator. It was inspired by rote but now it is +completely independent from it. dokkit uses filters like deplate and +maruku to generate output in a large variety of formats (tex, html, docbook, plain text, ...). +With dokkit you can: + +* generate static websites +* generate many types of documents in many formats (html, tex, plain text, etc.) +* write your documents using a simple wiki syntax and obtain high quality output +* generate different output formats from the same source document +* use models to quickly generate the documents you want (technical report, invoice, howto, guides, presentation, website, etc.) +* simply derive new documentation models from the existing ones +* simply modify existing models to fit your needs + For more information please execute: dokkit --help == FEATURES/PROBLEMS: dokkit key features are: -* a smart task system based on rake -* a consistent documentation per-model framework organized in templates, layouts, ruby classes, configuration files, resources -* a powerful templating system based on ERB +* a smart building system based on rake[http://rake.rubyforge.org] +* a documentation directory structure organized in pages, layouts, configuration files, resources +* a templating system based on ERB * a simple and flexible configuration system based on YAML +* support for partials == SYNOPSIS: - dokkit [options] [task] +To create a new documentation environment in <dirname> run: + dokkit <dirname> + == REQUIREMENTS: * deplate >= 0.8.0 +* maruku => 0.5.9 * rake >= 0.8.1 == INSTALL: sudo gem install dokkit + +== QUICK START + + $ dokkit mydocument + $ cd mydocument + $ rake == LICENSE: Copyright (c) 2008 Andrea Fazzi