Rtime CAN mentioned

[ortcan-www.git] / index.mdwn

diff --git a/index.mdwn b/index.mdwn
index 64e0497f5fd40aba7aafbc87d2982895481a678d..97ce1d0cbc77d99faf8517958fa6f6fd5d2a3c0a 100644 (file)
--- a/index.mdwn
+++ b/index.mdwn
@@ -3,12 +3,58 @@
 What is this?
 =============
 
-A collection of [CAN](wp) related tools developed at
-[Czech Technical University in Prague](rtime).
+A collection of [CAN][wp] related tools developed at
+[Czech Technical University in Prague][rtime].
+The development of these components started in frame
+of IST-2001 35102 [OCERA][ocera] European project.
+The components has been used all over the world in different
+academic and production environments and they are maintained
+mainly by CTU DCE department. There is list of CAN related
+work, CAN benchmarking and diploma thesis at that department on
+[Rtime CAN related pages][rtime-can].
 
+The access to CAN bus requires supported hardware
+interface. The project provides CAN device driver
+for Linux and other embedded environments to gain
+access to the network. The driver is named [[LinCAN|lincan]].
+
+The common interface to access different CAN interfaces
+and library to build higher level layers in implemented
+in Virtual/Versatile CAN API library - [[libVCA|vca]].
+
+## OrtCAN Build Instruction for Actual GIT Repository Sources 
+
+To obtain and build sources of the latest development
+version of former OCERA CAN components use
+
+    git clone git://ortcan.git.sourceforge.net/gitroot/ortcan/ortcan
+    cd ortcan/
+    git submodule update --init
+    make default-config
+    make
+
+The configuration options for the build can be specified
+in "config.omk" file. For x86_64 build line bellow
+has to be added into "config.omk" before final
+make command 
+
+    CFLAGS+=-fpic
+
+to build loadable modules (shared libraries/DLLs) corectly.
+For possible build options of included submodules read build
+instructions for respective component - [[libVCA|vca]], [[LinCAN|lincan]] ...
+The options can and should be combined in "config.omk" file
+in toplevel directory.
+
+The comprehensive documentation of the used build system
+([OCERA Make system][omk]) can be found on the [homepage][omk]
+of OMK project.
 
 [wp]:http://en.wikipedia.org/wiki/Controller_area_network
 [rtime]:http://rtime.felk.cvut.cz/
+[rtime-can]:http://rtime.felk.cvut.cz/can/
+[ocera]:http://sourceforge.net/projects/ocera/
+[omk]:http://rtime.felk.cvut.cz/omk/
 
 News
 ====