Skip to content

Latest commit

 

History

History
157 lines (97 loc) · 4.8 KB

README.md

File metadata and controls

157 lines (97 loc) · 4.8 KB

tocgen

Made with <3 by Amazing Cow.

Websites:

Description:

A stupidly simple HTML Table of Contents generator.

Motivation:

We want ToC on our pages, that's it ;D


As usual, you are very welcomed to share and hack it.

Usage:

  tocgen [-h] [-v] [-V] <filename>

Options:
  *-h --help    : Show this screen.
  *-v --version : Show app version and copyright.

   -V --verbose : Turn debug logs on.

   <filename> : The file's name that will be parsed.

Notes:
  Options marked with * are exclusive, i.e. the gosh will run that
  and exit after the operation.

Examples:

tocgen /path/to/the/html/page.html # Will output to the console.

Documentation:

Anyway if you didn't understand something let us know sending a mail to
[email protected] with the subject filled with the name of this repo.

Dependencies:

All dependecies are git submodules so issue:

git submodule update --init --recursive

and you're good to go!

License:

This software is proudly released under GPLv3.

BUGS:

We strive to make all our code the most bug-free as possible - But we know that few of them can pass without we notice ;).

Please if you find any bug report to [email protected] with the name of this project and/or create an issue here in Github.

TODO:

Check the TODO file for general things.

This projects uses the COWTODO tags.
So install cowtodo and run:

$ cd path/to/the/project
$ cowtodo

That's gonna give you all things to do :D.

Others:

Check our other Free Software repos and take a look at our free software site.