From 9945db4f4bd8ab035ad8c4863646181d9143cfee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89der=20F=2E=20Zulian?= Date: Wed, 30 May 2018 10:12:40 +0200 Subject: [PATCH] doc updated --- README.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 7d1c1b94..b42de057 100644 --- a/README.md +++ b/README.md @@ -118,15 +118,15 @@ $ cd ~/qwt-6.1 $ sudo make install ``` -For further information refer to [this](http://qwt.sourceforge.net/) +Further information about Qwt can be found [here](http://qwt.sourceforge.net/). To grant flexibility to the user the paths where to find some essential libraries and headers can be specified with environment variables. Make sure you have the environment variables below in your ~/.bashrc file. -Note that some of the variables are automatically generated by the scripts. If +**Note that some of the variables are automatically generated by the scripts. If you install the libraries in custom paths in your system you have to adapt the -environment variables accordingly. +environment variables accordingly**. ```bash # SystemC home and target architecture @@ -146,7 +146,14 @@ export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:${SYSTEMC_HOME}/lib-$SYSTEMC_TARGET_AR ### Coding Style -Please read the [coding-style document](coding-style.md) before start coding. +Please read the [coding-style document](coding-style.md) before starting to +code. + +A script is provided to apply the coding style. +```bash +$ cd util +$ ./make_pretty.sh +``` ### Buiding with QTCreator Execute the *QTCreator*. @@ -791,7 +798,10 @@ sim_files=" " ``` -**Traces to be used in each of the simulation setups have to be explicitly added to the traces list**. +**Traces have to be explicitly added to the traces list**. A new simulation +is defined by a combination of two elements, one from the simulation files +list and the other from the traces list. Thus the number of simulations +executed is the number of simulation files multiplied by the number of traces. ```bash traces=" @@ -841,8 +851,7 @@ Bank (B): 8 [30:32] (BA0 - BA2) -> 3 bit B B B | R R R R R R R R R R R R R R R R R | C C C C C C C C C C | Y Y Y ``` -The parameters for the DDR3-SDRAM DIMM with address mapping presented above -are presented below. +The parameters for the address mapping just described are presented below. ``` # Channel information.