diff --git a/READ-1ST.txt b/READ-1ST.txt new file mode 100644 index 0000000..093a060 --- /dev/null +++ b/READ-1ST.txt @@ -0,0 +1,69 @@ +OVERVIEW +-------- + +'tconfpy' is a configuration file parser for Python programmers. +It has two main components: + + tconfpy.py - A pure Python module which implements the + configuration file parser and analyzer. + + test-tc.py - A test driver you can use to learn about + how tconfpy works as well as for debugging + your own configuration files. + + +Documentation for both of these programs is provided in a number of +common document formats. + + +INSTALLATION +------------ + +The 'tconfpy' documentation discusses various installation strategies +and issues, but most users can use one of the following installation +schemes: + +For FreeBSD Systems: +-------------------- + +Make sure you are logged in as root, then: + + cd /usr/ports/devel/py-tconfpy + make install + + +For All Other Systems Including Win32 and Linux Distributions: +-------------------------------------------------------------- + +Make sure you are logged in as Administrator or root, then download +the current 'tconfpy' distribution from: + + http://www.tundraware.com/Software/tconfpy/ + +Then: + + cd directory-where-you-downloaded + tar -xzvf tconfpy-x.xxx.tar.gz + cd tconfpy-x.xxx + python setup.py install + +You will have to manually install the test-tc.py program somewhere in +your executable path. Similarly, install the man pages and/or other +documentation formats wherever is appropriate on your system. + + +LICENSE +------- + +Please take a moment to read through the 'tconfpy-license.txt' file +provided in the distribution. Use of this software is free for +non-commercial use. However, commercial use requires the payment of a +fee to TundraWare Inc. + + +QUESTIONS, CONCERNS, BUG REPORTS +-------------------------------- + +Go to: tconfpy@tundraware.com + +