RTNet and MinGW compilation correction

[orte.git] / readme

diff --git a/readme b/readme
index 8360fe131a8d1e1ac042fed95a358e97f40c9d93..f38c2e70634083bf437efbb54e71d940ce50dbeb 100644 (file)
--- a/readme
+++ b/readme
@@ -1,42 +1,65 @@
-                ORTE - OCERA Real-Time Ethernet
+                   ORTE - OCERA Real-Time Ethernet
 
+What is it?
+-----------
 The ORTE is open source implementation of RTPS communication protocol 
 defined by Real Time Innovations (http://www.rti.com). 
 RTPS is new application layer protocol targeted to real-time communication 
 area, which is build on top of standard UDP stack.
 
-Supported targets:
-Linux
-Windows - MinGW, MSVC
-RTLinux - need to fix UDP (Miquele or Ismael Ripoll), call function bind 
-with port 0, doesn't give any free port.
+Which targets are supported by ORTE?
+-----------------------------------
+UNIX - Linux, Solars, MacOS, FreeBSD
+Windows - MinGW, CygWin, MSVC
+RTLinux - with preliminary UDP stack
+RTAI - with RTNet
 
-To build: 
+note: was tested on
+sparc-sun-solaris2.9
+powerpc-apple-darwin6.8
+
+How to install it?
+------------------
 simply untar instalation package into desired directory, enter this 
 directory and issue following commands.
 
+UserSpace compilation:
 ./configure
 make 
 make install
 
-after this procedure ORTEManager and ORTEPing are placed in /usr/local/bin.
+after this procedure ortemanager and orteping are placed in /usr/local/bin
+, library in /usr/local/lib and include headers /usr/local/include
+
+RTLinux compilation:
+./configure --with-linux=/patched linux dir/ --with-rtlinux=/rtlinux dir/ 
+make 
+make install
+
+RTAI compilation:
+./configure --with-linux=/patched linux dir/ --with-rtai=/rtai dir/ --with-rtnet=/rtnet dir/ 
+make 
+make install
+
 
-To start:
-run :ORTEManager &
-see :ORTEManager -h for usaged
-note:ORTEManager have to run during all communication. For future work can 
-be added into /etc/init.d/... script for starting ORTEManager during boot
+How to start?
+-------------
+run :ortemanager &
+see :ortemanager -h for usage
+note:ortemanager have to be running during all communication. For future work can 
+be added into /etc/init.d/... script for starting ortemanager during boot
 of machine. This script (redhat and mandrake) is placed in 
-"orte/manager/rc/ORTEManagerd"
-For developping a RT application, ORTEManager can be running in userspace.
+"orte/manager/rc/ortemanagerd"
+For developping a RT application, ortemnager can be running in userspace.
 Start it with parameter "-k 192.168.4.2". This address is IP address of 
 RT application.
 
-To test communication:
-in a shell try to type "ORTEPing -p -s". So, now will be created one publisher
+How to test communication?
+-------------------------
+in a shell try to type "orteping -p -s". So, now will be created one publisher
 and one subscriber with same topic and type. If you see messages like
 
-[root@localhost ORTEPing]# ./ORTEPing -p -s
+[root@localhost ORTEPing]# ./orteping -p -s
 sent issue 1
 received fresh issue 1
 sent issue 2
@@ -44,12 +67,14 @@ received fresh issue 2
 sent issue 3
 received fresh issue 3
 
-communication works. If you see only sending messsages, it's sign that ORTEManager 
+communication works. If you see only sending messsages, it's sign that ortemanager 
 is not probably running.
-See "ORTEPing -h" for usaged.
+See "orteping -h" for usaged.
 
 Now, you can develop self applications (see documentation).
 
+
+
 Feedback is welcome - send bug reports, enhancements, checks, money
 orders, etc. to the address below.