X-Git-Url: http://rtime.felk.cvut.cz/gitweb/ortcan-www.git/blobdiff_plain/1c43e96ebcb600e1c44e17807b64814d91245a57..10c106b8479947db8164f2feda385c7ca3d139fa:/index.mdwn

diff --git a/index.mdwn b/index.mdwn
index 9990abc..2883ddd 100644
--- a/index.mdwn
+++ b/index.mdwn
@@ -4,11 +4,68 @@ What is this?
 =============
 
 A collection of [CAN][wp] related tools developed at
-[Czech Technical University in Prague][rtime].
+[Czech Technical University in Prague][ctu].
+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 members of [Real-Time Systems group][rtime] at
+[DCE][dce] department of [FEE][fel] faculty of [CTU][ctu]
+university. There is list of CAN related
+works - projects, CAN benchmarking and diploma thesis at
+[Rtime CAN guidepost][rtime-can] page.
 
+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]].
+
+Two GUI / Front End Tools for CAN bus monitoring
+and interaction are part of the project. The first is
+Java based CANmonitor with CAN/CANopen monitoring
+and device access capabilities. The other is Qt based
+CAN Bus Analyzer [[qCANanlyzer|qcanalyzer]].
+
+## 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/
+[dce]:http://dce.fel.cvut.cz/
+[fel]:http://fel.cvut.cz/
+[ctu]:http://www.cvut.cz/
+[ocera]:http://sourceforge.net/projects/ocera/
+[omk]:http://rtime.felk.cvut.cz/omk/
 
 News
 ====