Improved README.txt documentation on the tree.

diff --git a/rpp/blocks/README.txt b/rpp/blocks/README.txt
index 97ed2591cdceeeb8e499478bf71aeb06f806d41a..c53fdf9c6f60569d3fdb365eb269859ac63a63e6 100644 (file)
--- a/rpp/blocks/README.txt
+++ b/rpp/blocks/README.txt
@@ -63,20 +63,38 @@ Note: Each block that can detect fault condition should have a trigger output.
 
 Library file layout:
 
+    -> header.c and trailer.c
+
+        RPP framework for simple S-Functions.
+
+        This files are included at the head and tail of each S-Function file.
+        They include refactored and commonly repeated structures that pollute
+        S-Functions implementations. They include basic includes, required
+        definitions, macro definitions, common functions implementations and
+        documentation on optional functions and commented prototypes for
+        optional model calls/hooks.
+
+
     -> sfunction_{mnemonic}.c
 
         C-MEX S-Function implementation for {mnemonic} block.
 
         This file implements the {mnemonic} block using C-MEX S-Function API.
-        See refs/sfunctions.pdf for information about the S-Function API.
+        See the reference for information about the S-Function API.
+
+        Reference:
+            <repo>/refs/sfunctions.pdf
 
 
     -> tlc_c/sfunction_{mnemonic}.tlc
 
         Target Language Compiler (TLC) file for {mnemonic} block.
 
-        This file implements the C code inlining for {mnemonic} block.
-        See refs/rtw_tlc.pdf for information about the TLC API.
+        This file implements the C code inlining for {mnemonic} block. See the
+        reference for information about the TLC API.
+
+        Reference:
+            <repo>/refs/rtw_tlc.pdf
 
 
     -> tlc_c/common.tlc
@@ -85,6 +103,9 @@ Library file layout:
 
         This file implements common TLC functions used by all the blocks.
 
+        Reference:
+            None.
+
 
     -> slblocks.m
 
@@ -92,8 +113,11 @@ Library file layout:
 
         This file allows a group of blocks to be integrated into the Simulink
         Library and Simulink Library Browser. This file is required by Simulink
-        in order to interpret this folder as a block library.
-        See refs/rtw_ug.pdf p. 1127 for information about this file.
+        in order to interpret this folder as a block library. For information
+        about this file see the references.
+
+        Reference:
+            <repo>/refs/rtw_ug.pdf p. 1127
 
 
     -> rpp_lib.slx
@@ -103,6 +127,9 @@ Library file layout:
         Simulink block library that includes all the blocks. This file is
         referenced by slblocks.m
 
+        Reference:
+            None.
+
 
     -> compile_blocks.m
 
@@ -110,7 +137,11 @@ Library file layout:
 
         This script compiles all the sfunction blocks to MEX executables. This
         script is called by the rpp_setup() function in order make all the
-        blocks available to the Simulink environment.
+        blocks available to the Simulink environment or it can be called
+        independently when developing S-Functions.
+
+        Reference:
+            None.
 
 
 

diff --git a/rpp/lib/README.txt b/rpp/lib/README.txt
index 001127b99e10061718a664cdbaf5eff8e3567d6a..be279c956339e0959a0f0ea2550386e5ad1756f6 100644 (file)
--- a/rpp/lib/README.txt
+++ b/rpp/lib/README.txt
@@ -3,9 +3,8 @@
 #####################################
 
 
-// TODO: Rewrite description, this do not apply anymore.
 
-This is the RPP low-level driver library. It is designed to initialize basic
+It is designed to initialize basic
 elements of the hardware, provide a Hardware Abstraction Layer (HAL) and to
 provide low-level access and full control over the board, even if some actions
 implies hardware errors or unsafe actions.
@@ -16,8 +15,4 @@ Library file layout:
     FIXME: Find order and document.
 
 
-Code Composer Studio requires shared files TMS570LS313xFlashLnk.cmd and
-TMS570LS3137.ccxml to be in this current folder (and sadly, they cannot be
-references from somewhere else in the file system). Copy those files from
-parent directory into this directory in order to compile and upload code to the
-board.
+