-TODO
+#####################################
+# Simulink RPP Target and Library #
+#####################################
-refs/ hold reference oficial documentation. Each file has (when available) reference to this documentation.
-doc/ hold documentation generated for this project.
-rpp/ the custom Simulink target.
-rpp/lib hold the DRV (Driver library), RPP (High-Level modules library), OS (FreeRTOS) and UL (uLAN utility library) libraries. See rpp/{lib}/README.txt for information about each one.
+This is the repository of the Simulink target.
-To install:
- cd <extract_path/rpp/>
- rpp_setup();
+To work with the Simulink target you also need the RPP Library, which
+can be obtained from another repository with the following command:
-Just in case:
+ git submodule update --init
-./rpp/rpp should be on the MATLAB path.
-./rpp/blocks should be on the MATLAB path.
+This repository is structured as follows:
-But this is handled by rpp_setup();
+ - doc/ This directory hold documentation created for this project.
+ - refs/ Hold oficial reference documentation for CPU, chips,
+ languages, compiler, etc. This files are constantly
+ referenced within the source code files in this repository.
-Source reports (/doc) are in Nested format:
+ - rpp/blocks Hold the Simulink block library for the RPP Target.
+ C MEX S-Functions and TLC files can be found here.
+ See dedicated README.txt file for more information.
- http://nestededitor.sourceforge.net/
+ - rpp/demos Simulink demos that uses the RPP target and block library.
+ See dedicated README.txt file for more information.
-The last compiled PDF version should be available in <report>/publish/text/<report>.pdf
+ - rpp/lib RPP Library and API. See dedicated README.txt file for more
+ information.
+
+ - rpp/rpp Simulink RPP Target for code generation. See dedicated
+ README.txt file for more information.