This repository has been archived by the owner. It is now read-only.
shocco is a quick-and-dirty, literate-programming-style documentation generator for / in POSIX shell
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.gitignore
COPYING
Makefile
Markdown.pl
README
configure
shocco.sh

README

                     __
               _____/ /_  ____  ______________
              / ___/ __ \/ __ \/ ___/ ___/ __ \
             (__  ) / / / /_/ / /__/ /__/ /_/ /
            /____/_/ /_/\____/\___/\___/\____/


    shocco is  a quick-and-dirty, literate-programming-
    style documentation generator for / in POSIX shell.
    See the shocco generated docs for more information:

         <http://rtomayko.github.com/shocco/>

                     I N S T A L L


  (  git clone git://github.com/rtomayko/shocco.git &&
     cd shocco    &&      make      &&    make install  )


                         R U N


                      shocco --help
    shocco yourgreatscript.sh > yourgreatscript.sh.html


                        M O R E


                         Docco
         <http://jashkenas.github.com/docco/>
    The  original  quick-and-dirty,  hundred-line-long,
    literate-programming-style documentation generator.

                         Rocco
          <http://rtomayko.github.com/rocco/>
                    For and in Ruby.


                     C O P Y I N G


          This is MIT licensed Free Software

                 Copyright (C) 2010 by
                     Ryan Tomayko
              <http://tomayko.com/about>


        N O   L O N G E R   M A I N T A I N E D

    This repository is archived and no longer actively
    maintained by  @rtomayko as of 2017-11-08.  Issues
    and  PRs  documenting  current  issues  have  been
    intentionally left open for informational purposes.