Browse code

some more links and how to get started section

git-svn-id: http://svn.berlios.de/svnroot/repos/sems/trunk@262 8eb893ce-cfd4-0310-b710-fb5ebe64c474

Stefan Sayer authored on 07/03/2007 21:13:56
Showing 1 changed files
... ...
@@ -6,7 +6,7 @@
6 6
 
7 7
 Introduction:
8 8
 
9
- Sems is a extensible media server which helps you
9
+ SEMS is a extensible media server which helps you
10 10
  adding voice services to your VoIP system.
11 11
 
12 12
  Each module or plug-in extends your system. Audio
... ...
@@ -15,13 +15,13 @@ Introduction:
15 15
  Some modules called component modules provide 
16 16
  functionality for other modules to use.
17 17
 
18
- You can easely extend Sems by creating your own plug-ins.
18
+ You can easely extend SEMS by creating your own plug-ins.
19 19
 
20
- Applications can be written using the Sems framework API 
20
+ Applications can be written using the SEMS framework API 
21 21
  in C++, or in Python using an embedded python interpreter 
22 22
  of the ivr or py_sems plugins.
23 23
 
24
- The following default applications are shipped with Sems :
24
+ The following default applications are shipped with SEMS :
25 25
 
26 26
  * voicemail: records voice messages and mails them as email
27 27
 
... ...
@@ -48,7 +48,7 @@ Introduction:
48 48
 
49 49
  * pin_collect: collect a PIN, optionally verify it, and transfer the call
50 50
 
51
- Sems only support patent free codecs. Which means that we won't support codecs
51
+ SEMS only support patent free codecs. Which means that we won't support codecs
52 52
  like g729. On the other hand, we have support for all important patent free
53 53
  (g711u, g711a, GSM06.10 and iLBC).
54 54
 
... ...
@@ -56,9 +56,9 @@ Requirements:
56 56
 
57 57
  1. Ser version 0.9.6: SIP Epress Router (www.iptel.org/ser)
58 58
 
59
-    - Sems requires Ser as its SIP stack. 
60
-    - Sems & Ser communicate together through socket, which means that a Ser
61
-      instance is mandatory on every host using Sems.
59
+    - SEMS requires Ser as its SIP stack. 
60
+    - SEMS & Ser communicate together through socket, which means that a Ser
61
+      instance is mandatory on every host using SEMS.
62 62
 
63 63
  2. Python version >= 2.3 for the ivr (embedded python interpreter), optional
64 64
 
... ...
@@ -66,37 +66,50 @@ Requirements:
66 66
 
67 67
  4. lame >= 3.95 for mp3 file output, optional
68 68
 
69
+How to get started with SEMS:
70
+
71
+  To try out SEMS, the easiest is to follow one of the tutorials linked from
72
+  the SEMS homepage (e.g. http://www.iptel.org/howto_sems_voicemail). The
73
+  Application Modules Documentation page then gives an overview of the 
74
+  application modules that come with SEMS 
75
+  (http://ftp.iptel.org/pub/sems/doc/current/AppDoc.html).
76
+  
77
+  If you are interested in writing your own applications, the application 
78
+  development tutorial is a good start 
79
+  (http://www.iptel.org/howto/sems_application_development_tutorial), together
80
+  with the design overview (http://www.iptel.org/files/semsng-designoverview.pdf).
81
+  
69 82
 Installation:
70 83
 
71
- 1. Download Sems through svn:
84
+ 1. Download SEMS through svn:
72 85
     svn checkout svn://svn.berlios.de/sems/trunk
73 86
       -or-
74 87
     svn checkout http://svn.berlios.de/svnroot/repos/sems/trunk 
75 88
 
76
- 2. Compile Sems:
89
+ 2. Compile SEMS:
77 90
 
78 91
       make all
79 92
       make install
80 93
 
81
-    Notice: you don't need to execute 'make install' if you want to run Sems
94
+    Notice: you don't need to execute 'make install' if you want to run SEMS
82 95
             from the source tree.
83 96
      
84 97
     For detailed instructions, have a look at doc/COMPILING as well.
85 98
 
86 99
  3. Look at the default configuration file whether it fits your need:
87 100
 
88
-      If you installed Sems with 'make install', the configuration
101
+      If you installed SEMS with 'make install', the configuration
89 102
       is at '/usr/local/etc/sems/sems.conf'. 
90 103
       Else make your own using sems.conf.sample.
91 104
 
92 105
  4. Start Ser: 
93 106
 
94
-      Please read the Ser User's guide and doc/Configure-Sems-Ser-HOWTO
107
+      Please read the Ser User's guide and doc/Configure-SEMS-Ser-HOWTO
95 108
       if you don't known how to complete this stage, 
96 109
 
97
- 5. Start Sems:
110
+ 5. Start SEMS:
98 111
 
99
-      If you installed Sems with 'make install', sems can be
112
+      If you installed SEMS with 'make install', sems can be
100 113
       found at '/usr/local/sbin/sems'.
101 114
       If you need help starting 'sems', try 'sems -h'.
102 115
 
... ...
@@ -105,7 +118,7 @@ Troubleshooting:
105 118
 
106 119
  * RH thread problem:
107 120
 
108
-  Sems has currently problems being run on Redhat 9. If you cannot wait 
121
+  SEMS has currently problems being run on Redhat 9. If you cannot wait 
109 122
   until it is fixed, you may want to run ans_machine after running the
110 123
   following command:
111 124
 
... ...
@@ -127,14 +140,25 @@ Installed file using 'make install':
127 140
     source_path/scripts/sems[.redhat]    : example start-up scripts.
128 141
     source_path/sems.conf.example        : example configuration file.
129 142
 
143
+Documentation:
144
+
145
+  In the doc/ directory there is a set of files describing the applications
146
+  shipped with SEMS, alongside some more documentation. With 'make doc' you 
147
+  can generate the doxygen documentation in doc/doxygen_doc, which contains 
148
+  these files as well.
149
+
150
+  All documentation is available online linked from the SEMS homepage: 
151
+  www.iptel.org/sems.
152
+  
130 153
 
131 154
 Bug report & Contact:
132 155
 
133
-  If you have problems configuring Ser&Sems for your needs,
156
+  If you have problems configuring Ser&SEMS for your needs,
134 157
   look at the support information on the Ser homepage (www.iptel.org/ser)
135 158
   and the SEMS homepage (www.iptel.org/sems).
136 159
   The mailing lists (http://lists.iptel.org) for SEMS are the first 
137
-  address to ask for help, report bugs and improvements.
160
+  address to ask for help, report bugs and improvements. You need to be 
161
+  subscribed to be able to post to the lists.
138 162
 
139 163
 Authors:
140 164
 
... ...
@@ -151,7 +175,7 @@ Thanks goes to:
151 175
 
152 176
   * Jiri Kuthan (jiri@iptel.org)
153 177
       for the debuging work and help to implement
154
-      communicating part between Ser & Sems ('vm' module).
178
+      communicating part between Ser & SEMS ('vm' module).
155 179
 
156 180
   * All the others who helped during test session :-)
157 181