Update readme.

This commit is contained in:
Lukas Steiner
2023-05-23 13:53:51 +02:00
parent 0419bf3905
commit 0da9b6d14a

View File

@@ -51,11 +51,11 @@ Start using DRAMSys by cloning the repository.
### Dependencies ### Dependencies
DRAMSys requires a **C++17** compiler. The build process is based on **CMake** (minimum version **3.13**). Furthermore, the simulator is based on **SystemC**. SystemC is included as a submodule and will be build automatically with the project. If you want to use an external SystemC version, export the environment variables `SYSTEMC_HOME` (SystemC root directory) and `SYSTEMC_TARGET_ARCH` (e.g., linux64). DRAMSys requires a **C++17** compiler. The build process is based on **CMake** (minimum version **3.24**). Furthermore, the simulator is based on **SystemC**. SystemC is included with FetchContent and will be build automatically with the project. If you want to use a preinstalled SystemC version, export the environment variable `SYSTEMC_HOME` (SystemC installation directory). Also make sure that the SystemC library was built with the same C++ version.
### Building DRAMSys ### Building DRAMSys
To build the standalone simulator for running memory trace files or a traffic generator, create a build folder in the project root directory, then run CMake and make: To build the standalone simulator for running memory trace files or traffic generators, create a build folder in the project root directory, then run CMake and make:
```bash ```bash
$ cd DRAMSys $ cd DRAMSys
@@ -65,7 +65,7 @@ $ cmake ..
$ make $ make
``` ```
To include **DRAMPower** in your build enable the CMake option `DRAMSYS_WITH_DRAMPOWER`. If you plan to integrate DRAMSys into your own SystemC TLM-2.0 project you can build the DRAMSys library only by disabling the CMake option `DRAMSYS_BUILD_CLI`. To include **DRAMPower** in your build enable the CMake option `DRAMSYS_WITH_DRAMPOWER`. If you plan to integrate DRAMSys into your own SystemC TLM-2.0 project you can build only the DRAMSys library by disabling the CMake option `DRAMSYS_BUILD_CLI`.
To build DRAMSys on Windows 10 we recommend to use the **Windows Subsystem for Linux (WSL)**. To build DRAMSys on Windows 10 we recommend to use the **Windows Subsystem for Linux (WSL)**.