#! /usr/bin/env python

README=\
"""
This folder contains a pure Python port of Rbnarcissus
{http://idontsmoke.co.uk/2005/rbnarcissus/}. The narcissus.py
module contains the main parser code. The jsparse.py module
prints out a dictionary of functions in a javascript source
file passed as argument to it.

For testing the code, use jsparse.py as follows.

$ python jsparse.py <input.js>

The testnarcissus.py script can be used to do a quick
unit test on all the samples.

$ python testnarcissus.py

Please note that this is an alpha port and it has been tested
for only select javascript samples. However it should work for 
arbitrary javascript code once the bugs are fixed. 

Anand B Pillai <abpillai at __NOSPAM__ gmail dot com>
"""

print README