Add license (Apache 2.0)

[ert_linux.git] / README

diff --git a/README b/README
index 30bad48d4d85d0d0e3b76b58f1bff6194c81f982..a3a2bf63b7fd697fdb8c7978774039a38326035b 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,7 @@
-Mimimalistic Simulink Coder Target for Linux
+Minimalist Simulink Coder Target for Linux
 ============================================
+Authors: Michal Sojka <sojkam1@fel.cvut.cz>
+         Lukas Hamacek <hamacl1@fel.cvut.cz>
 
 The aim of this target is to allow Simulink to generate code that
 runs in real-time on Linux. This target tries to be minimalist in
@@ -19,4 +21,28 @@ From now on, Code Generation pane of Simulink Model Configuration
 Parameters should offer ert_linux.tlc as System Target File (after
 pressing "Browse...." button).
 
-Note: This target was tested with Matlab R2012b.
+Documentation
+-------------
+
+In order to cross-compile the generated source, modify the "Make
+command" in Code Generation pane to set the CC variable (and/or CPP
+for C++ compiler). For example:
+
+    make_rtw CC=arm-linux-gnueabi-gcc
+
+Pointers to more ERT Linux target documentation can be found at the
+project SourceForge page http://lintarget.sourceforge.net/.
+
+Michal Sojka's blogpost about the actual version can be found at
+http://rtime.felk.cvut.cz/~sojka/blog/on-generating-linux-applications-from-simulink/.
+
+Development sources repository
+------------------------------
+
+  http://rtime.felk.cvut.cz/gitweb/ert_linux.git
+
+  git clone git://rtime.felk.cvut.cz/ert_linux.git
+
+Note: This target was tested with Matlab R2012b and R2013a
+      and Humusoft MF624 cards with Linux kernels up to 3.12 RT
+      on 64-bit Debian GNU/Linux system.