Added Simulink target library README.txt file.

diff --git a/rpp/demos/.gitignore b/rpp/demos/.gitignore
new file mode 100644 (file)
index 0000000..e69de29

diff --git a/rpp/rpp/README.txt b/rpp/rpp/README.txt
new file mode 100644 (file)
index 0000000..53716c2
--- /dev/null
+++ b/rpp/rpp/README.txt
@@ -0,0 +1,129 @@
+#####################################
+# Simulink Target for RPP           #
+#####################################
+
+
+This library provides support for C source code generation from Simulink models
+and compilation of that code on top of the RPP library and the FreeRTOS
+operating system. This library uses Texas Instrument ARM compiler (armcl)
+included in the Code Generation Tools available with Code Composer Studio, and
+thus it depends on it for proper functioning.
+This library also provides support for automatically download the compiled
+machine code to the RPP board.
+
+
+
+Install RPP Target support:
+
+1) Get the repository (omit this if you're reading this from the README.txt file
+   in the repository). From a shell:
+
+    git clone ssh://git@rtime.felk.cvut.cz/jenkicar/rpp-simulink.git
+
+This is a private server, you require your SSH private key to be authorized.
+For access please consult the Real-Time Systems Group, Department of Control
+Engineering, Faculty of Electrical Engineering, Czech Technical University in
+Prague. For details about this git server consult:
+
+    http://rtime.felk.cvut.cz/hw/index.php/Git_repository_on_this_server
+
+
+2) Install Code Composer Studio.
+
+Install Code Composer Studio (CCS) from the following URL:
+
+    http://processors.wiki.ti.com/index.php/Category:Code_Composer_Studio_v5
+
+CCS GUI is not used, this target relies on the ARM Compiler and Linker
+(<ccs>/tools/compiler/arm_5.X.X/bin/armcl) and the Debug Server Scripting (DSS)
+Generic Loader (<ccs>/ccs_base/scripting/examples/loadti/loadti.sh) command line
+tools.
+Please note that all the development was done in a Ubuntu 12.04 LTS GNU/Linux
+machine using the CCS Linux version.
+
+    armcl reference documentation:
+        <repo>/refs/armcl.pdf, also available on
+        http://processors.wiki.ti.com/index.php/TI_Compiler_Information#Compiler_Manuals
+
+    loadti.sh reference documentation:
+        loadti.sh file itself, has great documentation on arguments and function.
+        http://processors.wiki.ti.com/index.php/Loadti
+
+Notes on installing Code Composer Studio on Ubuntu 64bits:
+
+    After installation the application can be run with:
+
+        cd <ccs>/ccsv5/eclipse/
+        ./ccstudio
+
+    If the application fails to start is because CCS5 is a 32bits application a
+    thus requires 32bits libraries:
+
+        sudo apt-get install libgtk2.0-0:i386 libxtst6:i386
+
+    If the application crashes with a segmentation fault do:
+
+        Edit <ccs>/ccsv5/eclipse/plugins/com.ti.ccstudio.branding_<your version number>/plugin_customization.ini
+        And change key org.eclipse.ui/showIntro to false.
+
+    Choose "FREE License - for use with XDS100 JTAG Emulators" on the licensing options.
+    This target is configured to upload using this particular hardware.
+
+    You may create a symbolic link and a desktop entry:
+
+        sudo ln -s <ccs>/ccsv5/eclipse/ccstudio /usr/local/bin/ccstudio
+
+    And put in ~/.local/share/applications/ccs5.desktop
+
+        [Desktop Entry]
+        Version=1.0
+        Type=Application
+        Terminal=false
+        Exec=ccstudio
+        Name=Code Composer Studio
+        Icon=/usr/local/ti/ccsv5/eclipse/icon.xpm
+
+
+3) Install RPP Target:
+
+    Open Matlab and type on command window:
+
+        cd <repo>/rpp/rpp/
+        rpp_setup()
+
+    This will launch the RPP setup script. This script will ask the user to
+    provide the path to the CCS compiler root directory (the directory where
+    armcl is located), normally:
+
+        <ccs>/tools/compiler/arm_5.X.X/
+
+    Find a more detailed description of what this script does in the section
+    below.
+
+
+4) Create a new model or load a demo.
+
+    Demos are located on <repo>/rpp/demo or you can start a new model and
+    configure target to RPP.
+
+
+
+Library file layout:
+
+    -> rpp_setup.m
+
+        RPP Target install script.
+
+        This script will, among other things, ask the user to provide the
+        location of the armcl parent directory, infer and save some relevant
+        CCS paths, add paths to Matlab path and build S-Function blocks for
+        user's arquitecture (using Matlab's mex command line tool).
+
+
+    -> foo/bar.m
+
+        Short description.
+
+        Lorens ipsum large description.
+
+