]> rtime.felk.cvut.cz Git - jenkicar/rpp-simulink.git/commitdiff
Improved RPP Target library documentation.
authorCarlos Miguel Jenkins Pérez <carlos@jenkins.co.cr>
Wed, 29 May 2013 23:35:32 +0000 (01:35 +0200)
committerCarlos Miguel Jenkins Pérez <carlos@jenkins.co.cr>
Wed, 29 May 2013 23:35:32 +0000 (01:35 +0200)
rpp/blocks/README.txt
rpp/rpp/README.txt
rpp/rpp/rpp_setup.m

index 56b815937876b4a8a857c7948bcc686e82759a9c..97ed2591cdceeeb8e499478bf71aeb06f806d41a 100644 (file)
@@ -59,6 +59,8 @@ The blocks ideally included in this library are:
 Note: Each block that can detect fault condition should have a trigger output.
       High-power output provides current flow as an input to the model.
 
+
+
 Library file layout:
 
     -> sfunction_{mnemonic}.c
@@ -111,6 +113,7 @@ Library file layout:
         blocks available to the Simulink environment.
 
 
+
 Library block description:
 
 The following are the currently specified Simulink blocks.
index 53716c2e5d15a91a7982377765616fc441584547..62c6f326867a4249e7b4ada63eff67e97b1cc0dd 100644 (file)
@@ -11,9 +11,7 @@ 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:
+How to 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:
@@ -120,10 +118,74 @@ Library file layout:
         user's arquitecture (using Matlab's mex command line tool).
 
 
-    -> foo/bar.m
+    -> rpp.tlc
 
         Short description.
 
         Lorens ipsum large description.
+        Reference: <Jam>
+
+
+    -> rpp.tmf
 
+        Short description.
+
+        Lorens ipsum large description.
+        Reference: <Jam>
+
+
+    -> rpp_download.m
+
+        Short description.
+
+        Lorens ipsum large description.
+        Reference: <Jam>
+
+
+    -> rpp_file_process.tlc
+
+        Short description.
+
+        Lorens ipsum large description.
+        Reference: <Jam>
+
+
+    -> rpp_lib_support.m
+
+        Short description.
+
+        Lorens ipsum large description.
+        Reference: <Jam>
+
+
+    -> rpp_make_rtw_hook.m
+
+        Short description.
+
+        Lorens ipsum large description.
+        Reference: <Jam>
+
+
+    -> rpp_select_callback_handler.m
+
+        Short description.
+
+        Lorens ipsum large description.
+        Reference: <Jam>
+
+
+    -> rpp_srmain.tlc
+
+        Short description.
+
+        Lorens ipsum large description.
+        Reference: <Jam>
+
+
+    -> target_tools.mk
+
+        Short description.
+
+        Lorens ipsum large description.
+        Reference: <Jam>
 
index 81f395fca0666d65dc147e94adf8ea9ed3bd3199..440057d02f4b6755bb7acae80275335be5409a3b 100644 (file)
 %
 % File : rpp_setup.m
 % Abstract:
-%     This file script adds paths for RPP target to the MATLAB path.
-%     IMPORTANT: This script _MUST_ be run by user after installing before
-%     using the target. To do so:
-%         1. Extract target package.
+%     RPP Target install script.
+%
+%     IMPORTANT: This script _MUST_ be run by user after extracting the target
+%                package and before using the target. To execute:
+%
+%         1. Start Matlab.
 %         2. Change directory (cd) to this file folder.
-%         3. Execute rpp_setup();
+%         3. Execute rpp_setup() on command window.
 %
 % References:
 %     rtw_ug.pdf p. 1137