]> rtime.felk.cvut.cz Git - jenkicar/rpp-simulink.git/commitdiff
doc: Final tweaks and updates before release
authorMichal Sojka <sojkam1@fel.cvut.cz>
Mon, 16 Feb 2015 10:32:54 +0000 (11:32 +0100)
committerMichal Sojka <sojkam1@fel.cvut.cz>
Mon, 16 Feb 2015 10:32:54 +0000 (11:32 +0100)
doc/rpp_simulink.tex

index d6ce51b0948454847886bb16db0ecf31ce3c46b2..55e7f505ee9a74e6f503b661be0c0a16aca15847 100644 (file)
@@ -485,9 +485,12 @@ example).
     \item Git 1.9.4.msysgit.2 (optionally)
 \end{itemize}
 
-\section{Software and tools} 
+\section{Software tools}
 \label{sec-software-and-tools}
 
+This section covers tool which are needed or recommended for work with
+the RPP project.
+
 \subsection{TI Code Composer Studio}
 \label{sec-ti-ccs}
 Code Composer Studio (CCS) is the official Integrated Development Environment
@@ -668,21 +671,23 @@ for some reason.
     \item Compile the static library using the procedure from Section
       \ref{sec-compilation}. The compiled library \texttt{rpp-lib.lib}
       will appear in the project root directory.
-       \item Copy the compiled library to the application, where you want
-      to test and use the new library version.
+    \item Either copy the compiled library and the content of the
+      \texttt{rpp/include} directory to the application, where you
+      want to use it or use the library in place, as described in
+      Section~\ref{sec:creating-new-project}.
       \begin{itemize}
       \item In the rpp-simulink application the library is located in
         the \texttt{rpp/lib} folder.
       \item In the rpp-test-sw application the library is located in
-        \texttt{rpp-lib} folder.
+        the \texttt{rpp-lib} folder.
       \end{itemize}
 \end{enumerate}
 
 \subsection{rpp-simulink}
 \label{sec-rpp-simulink-installation}
-This section describes how install the rpp-simulink project, which is
-needed to try the demo models or to build your own models that use RPP
-blocks.
+This section describes how to install the rpp-simulink project, which
+is needed to try the demo models or to build your own models that use
+the RPP blocks.
 
 \begin{enumerate}
 \item Unzip the \texttt{rpp-simulink-version.zip} file.
@@ -690,10 +695,9 @@ blocks.
   \ref{sec-configuration-simulink-for-rpp} for configuring Matlab
   Simulink for the RPP project.
 \item Follow the procedure from Section \ref{sec-crating-new-model}
-  for instruction about creating your own model which will use the RPP
-  Simulink blocks or follow the instructions in
-  Section~\ref{sec-running-model-on-hw} for downloading the firmware
-  to the real RPP hardware.
+  for instructions about creating your own model which will use the
+  RPP Simulink blocks or follow the instructions in
+  Section~\ref{sec-running-model-on-hw} for downloading the firmware to the RPP hardware.
 \end{enumerate}
 
 \subsection{rpp-test-sw}
@@ -753,6 +757,7 @@ the standard Eclipse IDE.
 
 \newpage
 \subsection{Creating new project}
+\label{sec:creating-new-project}
 Follow these steps to create an application for RM48 MCU compiled with
 CGT.
 
@@ -1537,6 +1542,10 @@ the RPP library are summarized below.
 \subsection{ARM target (RPP board)}
 \label{sec:arm-target-rpp}
 
+The detailed instructions are presented in
+Section~\ref{sec:creating-new-project}. Here we briefly repeat the
+main steps.
+
        \begin{compactitem}
     \item Configure include search path to contain the directory of
       used FreeRTOS version, e.g.
@@ -1545,7 +1554,7 @@ the RPP library are summarized below.
     \item Include \texttt{rpp/rpp.h} header file or just the needed
       peripheral specific header files such as \texttt{rpp/can.h}.
     \item Add library \texttt{rpp-lib.lib} to the linker libraries.
-      The RPP library must be looked for before Texas Instruments
+      The RPP library must be placed before Texas Instruments
       support library \texttt{rtsv7R4\_T\_le\_v3D16\_eabi.lib}.
     \item Use the provided linker command file
       \texttt{RM48L952FlashLnk.cmd}.