README file updated.
This commit is contained in:
33
README.md
33
README.md
@@ -32,15 +32,22 @@ order to get your changes merged into to the official codebase.
|
||||
$ git clone --recursive https://<user>@git.rhrk.uni-kl.de/<user>/dram.vp.system.git
|
||||
```
|
||||
|
||||
Also, the official repository must be added as a remote for your fork.
|
||||
After cloning go to the project directory.
|
||||
|
||||
``` bash
|
||||
$ cd dram.vp.system
|
||||
```
|
||||
|
||||
When working with a fork, the official repository must be added as a remote for
|
||||
your fork.
|
||||
|
||||
``` bash
|
||||
$ git remote add upstream https://<user>@git.rhrk.uni-kl.de/EIT-Wehn/dram.vp.system.git
|
||||
$ git remote -v
|
||||
```
|
||||
|
||||
After a pull request being accepted and merged into the official repository
|
||||
you should get your fork updated.
|
||||
Also, after a pull request being accepted and merged into the official
|
||||
repository you should get your fork updated.
|
||||
|
||||
``` bash
|
||||
$ git fetch upstream
|
||||
@@ -49,13 +56,7 @@ $ git merge upstream/master
|
||||
$ git push origin HEAD
|
||||
```
|
||||
|
||||
After cloning go to the project directory.
|
||||
|
||||
``` bash
|
||||
$ cd dram.vp.system
|
||||
```
|
||||
|
||||
### With QTCreator
|
||||
### Buiding with QTCreator
|
||||
Execute the *QTCreator*.
|
||||
|
||||
``` bash
|
||||
@@ -82,7 +83,7 @@ In the left bar go to **Projects -> Build & Run -> Build Steps -> Make**.
|
||||
Click in **Details** then **Make arguments** and add **-j** followed by the
|
||||
number you got.
|
||||
|
||||
### Without QTCreator
|
||||
### Building without QTCreator
|
||||
|
||||
In case you prefer a command line interface to the QTCreator GUI you can also
|
||||
use **qmake** to generate a Makefile and then compile the project.
|
||||
@@ -235,7 +236,7 @@ Below are listed the configuration sections and configuration fields.
|
||||
|
||||
XML files describe the address mapping to be used in the simulation.
|
||||
|
||||
The file [am_wideio.xml](dram/resources/configs/amconfigs/am_wideio.xml) is
|
||||
The file [am_wideio.xml](DRAMSys/dram/resources/configs/amconfigs/am_wideio.xml) is
|
||||
a good example.
|
||||
|
||||
``` xml
|
||||
@@ -248,7 +249,7 @@ Below are listed the configuration sections and configuration fields.
|
||||
</addressmapping>
|
||||
```
|
||||
|
||||

|
||||

|
||||
|
||||
``` xml
|
||||
<addressmapping>
|
||||
@@ -260,11 +261,11 @@ Below are listed the configuration sections and configuration fields.
|
||||
</addressmapping>
|
||||
```
|
||||
|
||||

|
||||

|
||||
|
||||
- **Memory Configuration**
|
||||
|
||||
The content of [fifo.xml](dram/resources/configs/memconfigs/fifo.xml) is
|
||||
The content of [fifo.xml](DRAMSys/dram/resources/configs/memconfigs/fifo.xml) is
|
||||
presented below as an example.
|
||||
|
||||
``` xml
|
||||
@@ -339,7 +340,7 @@ Resources of the simulator are available inside of the **resources** directory
|
||||
and its sub-directories.
|
||||
|
||||
``` bash
|
||||
$ cd /projects/dram.vp.system/dram/resources
|
||||
$ cd DRAMSys/dram/resources
|
||||
```
|
||||
|
||||
A description of the content each directory follows.
|
||||
|
||||
Reference in New Issue
Block a user