JORTE: ignore 'int-to-pointer' and 'pointer-to-int' compiler warnings

[orte.git] / readme

diff --git a/readme b/readme
index 635a8bdde118e08963c20fc5a785534d7384058f..3f61db635c4f2522f539c9c79849798b8cfd40e3 100644 (file)
--- a/readme
+++ b/readme
@@ -1,8 +1,9 @@
-                   ORTE - OCERA Real-Time Ethernet
+                   ORTE - Open Real-Time Ethernet
+                   ------------------------------
 
 What is it?
 -----------
-The ORTE is open source implementation of RTPS communication protocol 
+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.
@@ -10,7 +11,7 @@ area, which is build on top of standard UDP stack.
 Which targets are supported by ORTE?
 -----------------------------------
 UNIX - Linux, Solars, MacOS, FreeBSD
-Windows - MinGW, CygWin, MSVC
+Windows - MinGW, CygWin, MSVC, PharLap
 RTLinux - with preliminary UDP stack
 RTAI - with RTNet
 JAVA
@@ -19,8 +20,9 @@ note: was tested on
 sparc-sun-solaris2.9
 powerpc-apple-darwin6.8
 
-How to install it?
-------------------
+How to compile and install it?
+---------------------------
+
 simply untar instalation package into desired directory, enter this 
 directory and issue following commands.
 
@@ -29,31 +31,44 @@ UserSpace compilation:
 make 
 make install
 
-after this procedure ortemanager and orteping are placed in /usr/local/bin
-, library in /usr/local/lib and include headers /usr/local/include
+After this procedure ortemanager and orteping are placed in /usr/local/bin,
+library is placed in /usr/local/lib and include headers in /usr/local/include.
 
-RTLinux compilation with wIP:
-./configure --with-linux=/patched linux dir/ --with-rtlinux=/rtlinux dir/ --with-rtlinuxwip=/wip dir/
+RTLinux compilation with wIP: (DEPRICATED)
+./configure --with-linux=/patched_linux_dir/ --with-rtlinux=/rtlinux_dir/ --with-rtlinuxwip=/wip_dir/
 make 
 make install
 
-RTLinux compilation with onetd:
-./configure --with-linux=/patched linux dir/ --with-rtlinux=/rtlinux dir/ --with-rtlinuxonetd=/onetd dir/
+RTLinux compilation with onetd: (DEPRICATED)
+./configure --with-linux=/patched_linux_dir/ --with-rtlinux=/rtlinuxh_dir/ --with-rtlinuxonetd=/onetd_dir/
 make 
 make install
 
 RTAI compilation:
-./configure --with-linux=/patched linux dir/ --with-rtai=/rtai dir/ --with-rtnet=/rtnet dir/ 
+./configure --with-linux=/patched_linux_dir/ --with-rtai=/rtai dir/ --with-rtnet=/rtnet dir/ 
 make 
 make install
 
 JAVA compilation:
-./configure --with-java=/java home dir/ 
+./configure --with-java=/java_home_dir/ 
 make
 make install
 
+
+Another way, how to compile ORTE project is to use OMK compilation
+method. See https://rtime.felk.cvut.cz/omk/ for details about OMK. For
+standalone compilation (without OCERA), just copy folder orte to other
+(private) destination. Run ./switch2standalone in the root of orte
+directory.
+
+Now just type a run
+make
+
+in the root of the ORTE project will be create two direcories, which contains compilation results.
+
 How to start?
 -------------
+
 run :ortemanager &
 see :ortemanager -h for usage
 note:ortemanager have to be running during all communication. For future work can 
@@ -66,6 +81,7 @@ RT application.
 
 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
 
@@ -83,7 +99,28 @@ See "orteping -h" for usaged.
 
 Now, you can develop self applications (see documentation).
 
+Obtaining the code from Git repository
+--------------------------------------
+
+You can obtain the latest ORTE source code from Git repository by
+running:
+
+  $ git clone git://git.code.sf.net/p/orte/orte
+
+Building From Git
+-----------------
+
+To build ORTE code from Git, you will need Autoconf, Automake, and any
+tools that those utilities require (GNU m4, Perl, etc.). See the
+configure.in file to find the minimum versions of each of these tools.
+
+After checking out the code, you will need to perform these steps to
+get to the point where you can run "configure" and "make".
+
+ $ make -f Makefile.cvs 
+
 Feedback is welcome - send bug reports, enhancements, checks, money
 orders, etc. to the address below.
 
-Petr Smolik             petr.smolik@wo.cz  
+Petr Smolik             petr.smolik@wo.cz
+Michal Sojka           sojkam1@fel.cvut.cz