Skip to content

Commit 1443d61

Browse files
committed
docs: modify env setup section
1 parent 64867ea commit 1443d61

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ To compatible with SoC test, All types of TreeCore have same memory map range:
101101
## Usage
102102
adsfadfasdfasf
103103
### Enviroment Setup
104-
> NOTE: All of the components are installed under linux operation system. To gurantee the compatibility and stability, I strongly recommend using `ubuntu 20.04 LTS`.
104+
> NOTE: All of the components and tools are installed under linux operation system. To gurantee the compatibility and stability, I strongly recommend using `ubuntu 20.04 LTS`. `ubuntu 18.04` and `ubuntu 16.04` is not supported official.
105105
106106
First, you need to install verilator, mill and dependency libraries:
107107
```bash
@@ -110,15 +110,16 @@ $ cd rtl
110110
$ chmod +x scripts/install.sh
111111
$ make install
112112
```
113-
Then, download and configuare all components from the github:
113+
Then, download and configuare all components from the github and gitee:
114114
```bash
115115
$ chmod +x scripts/setup.sh
116116
$ make setup
117117
```
118-
After that, you need to set the `NEMU_HOME` and `NOOP_HOME` environment variables:
118+
After that, you need to add the `NEMU_HOME` and `NOOP_HOME` environment variables in sh environment config file:
119119
```bash
120-
$ NEMU_HOME=$(pwd)/dependency/NEMU
121-
$ NOOP_HOME=$(pwd)/dependency
120+
$ echo export NEMU_HOME=$(pwd)/dependency/NEMU >> ~/.bashrc # according to shell type your system uses
121+
$ echo export NOOP_HOME=$(pwd)/dependency >> ~/.bashrc
122+
$ exec bash
122123
```
123124

124125
Becuase running the isa test don't need 8G memory, so you need to config the simulation memory size to reduce memory usage. You need to type `make menuconfig` as follow:
@@ -138,6 +139,7 @@ $ make menuconfig
138139

139140
Usually, 256MB memory address space is enough for simulation. You need to switch into `[Memory - Configuration]` menu and change `[Memory size]` value into `0x10000000` manually as follow picture shows. It can adjust difftest's simulation memory size from 8G to 256MB.
140141

142+
> NOTE: In fact, the `Memory size` has been modified to `0x10000000` in `make setup` phase. Now, you only need to confirm it once more time.
141143
<p align="center">
142144
<img src="https://raw.githubusercontent.com/microdynamics-cpu/tree-core-cpu-res/main/nemu-build-mem.png"/>
143145
<p align="center">
@@ -148,23 +150,24 @@ Usually, 256MB memory address space is enough for simulation. You need to switch
148150
Last, remember to type `Save` button in bottom menu to save the `.config` file. Then, type `Exit` to exit the menuconfig.
149151

150152
### Compile runtime libraries
151-
If you already run above steps correctly, you need to compile runtime libraries as follow:
153+
If you already run above commands correctly, you need to compile runtime libraries as follow:
152154

153155
```bash
154156
$ make nemuBuild
155157
$ make dramsim3Build
156158
```
157159

158160
### Compile testcases
159-
```bash
161+
Two type of ISA testcases set are used: `riscv test` and `cpu test`.
162+
```bash
160163
$ make riscvTestBuild
161164
$ make cpuTestBuild
162165
$ make amTestBuild
163166
```
164167
> NOTE: you need to enough memory to compile the
165168
166169
### Recursive test
167-
When you modify the processor design, you
170+
or after you modify the processor design, you need to run recursive test to gurantee the
168171
```bash
169172
$ make unit-tests
170173
```

0 commit comments

Comments
 (0)