Change license to MIT

[jenkicar/rpp-simulink.git] / README.txt

diff --git a/README.txt b/README.txt
index f89c3dfa2d2c534eca835485f576ca443fa6c14b..b31d16b6d474ed72921a19dea6849e7c8592e58c 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -1,16 +1,31 @@
-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.
-src/ hold source of the custom target for RPP.
+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.
+
+    - 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.
+
+    - rpp/demos     Simulink demos that uses the RPP target and block library.
+                    See dedicated README.txt file for more information.
+
+    - 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.