Make easy ADL configuration (lite version)

[anna.git] / example / diameter / launcher / resources_lite / README

diff --git a/example/diameter/launcher/resources_lite/README b/example/diameter/launcher/resources_lite/README
index ffb4633..dc46f77 100644 (file)
--- a/example/diameter/launcher/resources_lite/README
+++ b/example/diameter/launcher/resources_lite/README
@@ -1,21 +1,33 @@
-
 ABOUT CONTENT
 -------------
-Stacks available at './stacks'.
-The launcher uses the configuration given at './run.sh' variable definition section. Edit it
- if you want to adapt your system networking setup.
-
 Template for xml messages (message.dtd) and dictionaries (dictionary.dtd) are informative, not
-actually required by process. Located at './DTDs'.
+actually required by process. They are located at './DTDs'. Stacks are available at './stacks'.
+There are also some stuff (hex/xml examples, etc.) which could be useful.
+
+Firstly you have to configure this directory in order to choose the type of launcher which will
+be preconfigured for your basic needs: client, server, balancer (proxy) and dummy process (this
+last is used for code/encode and does not launch any communication interface).
+
+If you are going to launch different processes, we recommend to clone this whole directory into
+another one (call it 'ADL-client', 'ADL-server_2', 'Diameter_proxy', or whatever you want), and
+then configure it again.
+
+Execute './configure.sh' and follow the intructions. You can call this several times, but the
+last configuration will be the one which prevails.
 
 STARTING THE PROCESS
 --------------------
-Start with 'run.sh'. You could manually edit such script adding parameters as '-trace debug' to
-get complete 'launcher.traces'. Execute 'ADL-launcher' without arguments to see a complete
-command-line help.
+After configuring the ADL execution context, a new script has been created: 'run.sh'.
+You can manually edit such script adding parameters as '-trace debug' to get complete traces,
+or adapt the communication endpoints for your environment.
+
+Launch the executable process without arguments to see a complete command-line help.
+Don't be scared. There are plenty of possibilities but the 'run.sh' script has been prepared
+for the type of launcher you wanted.
 
 OPERATION
 ---------
 Management interface for lite version is based on SIGUSR2 signal caugh. Use './operation.sh'
-script to send any operation to the process.
+script to send any operation to the process. Ask for help with that script to see all the
+operations supported.