cleaned up some debug prints
[urisagit/Stem.git] / README
1 This is the README file for the Stem system.  Stem is released under
2 the GNU General Public License (http://www.gnu.org/copyleft/gpl.html).
3 For more information regarding commercial licenses please visit the
4 Stem Systems website at http://www.stemsystems.com.
5
6 The information below assumes the Stem tarball unpacks into a dir with
7 the name stem-0.NN (where NN is the version number). That directory path
8 will be referred to as $STEM.
9
10 You can find more text (FAQ, products) on the Stem web site:
11 http://www.stemsystems.com. The technical notes are also on the web site
12 but may be more up to date in the tarball.
13
14
15 Stem Installation.
16
17 The INSTALL file has complete instructions on how to install Stem on
18 your system. 
19
20 Stem Demonstrations
21
22 There are 4 Stem demonstration scripts. Read the DEMO file first to
23 learn about their common features and then read the individual DEMO_*
24 files for each one.
25
26 Manifest
27
28 README (this file) is in:
29
30         $STEM/README
31
32 Stem installation instructions are in:
33
34         $STEM/INSTALL
35
36 Stem demonstration script instructions are in:
37
38         $STEM/DEMO
39         $STEM/DEMO_CHAT
40         $STEM/DEMO_INETD
41         $STEM/DEMO_TAIL
42
43 Event.pm is in the tarball (You can also it from CPAN):
44
45         $STEM/modules/Event-0.77.tar.gz
46
47 Stem modules are in:
48
49         $STEM/lib/Stem.pm
50         $STEM/lib/Stem/
51
52 Stem Example Configuration files are in:
53
54         $STEM/conf/
55
56 Stem Executable scripts are in:
57
58         $STEM/bin/
59
60 Technical Design Notes are in:
61
62         $STEM/Design/
63
64 Documentation is in:
65
66         $STEM/Docs/
67
68         The latest FAQ is on the web site (http://www.stemsystems.com)
69
70 Stem Cookbook is in:
71
72         $STEM/Cookbook/
73
74 ssfe (split screen front end) is found in the sirc tarball:
75
76         $STEM/extras/sirc-2.211.tar.gz
77
78 Test scripts are in:
79
80         $STEM/t/
81
82 Utility scripts are in:
83
84         $STEM/utils/