Skip to content

Latest commit

 

History

History
53 lines (34 loc) · 1.64 KB

aagen.README.md

File metadata and controls

53 lines (34 loc) · 1.64 KB

aagen is a command line tool to take a source input file formatted for the macro() processor, and generate the results to a file or to the stdout stream.

aagen requires aa_macro.py

aagen can use aa_ansiicolor.py if it is present to do syntax highlighting on its errors and usage outputs. If this import library is not present, aagen simply won't use color.

Invocation; use aagen if aagen is in the current path but not the current directory, or ./aagen if aagen is in the current directory.

An example file is provided:

aagen-example.txt

You can utilize the example file this way:

aagen aagen-example.txt
aagen aagen-example.txt -f aagen-example.html

...or...

./aagen  aagen-example.txt
./aagen aagen-example.txt -f aagen-example.html

Type aagen or ./aagen by itself for a listing of the available options.

Quick Reference Generation

The repo includes a quick reference file, quickref.txt

This file contains the "meat" of the quick reference, which is designed using styles. It can be generated as either markdown, as you see it here, or as HTML, as you se it here..

The way this is done is to use a different set of styles, which define what the styles in quickref.txt actually mean. Here are the two command lines:

aagen -i qr_html.txt -f quickref.html quickref.txt aagen -i qr_markdown.txt -f quickref.md quickref.txt

The first one generates an HTML output file, while the second generates a markdown file.

This serves as a small demonstration of just how flexibly you can generate output using styles.