Skip to content

Commit 5633a9d

Browse files
committed
docs: fix some typos in readme doc
1 parent 49be7fd commit 5633a9d

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -114,20 +114,20 @@ Then, download and configuare all components from the github and gitee:
114114
$ chmod +x scripts/setup.sh
115115
$ make setup
116116
```
117-
After that, you need to add the `NEMU_HOME` and `NOOP_HOME` environment variables in sh environment config file:
117+
After that, you need to add the `NEMU_HOME` and `NOOP_HOME` environment variables to your shell environment config file:
118118
```bash
119119
$ echo export NEMU_HOME=$(pwd)/dependency/NEMU >> ~/.bashrc # according to shell type your system uses
120120
$ echo export NOOP_HOME=$(pwd)/dependency >> ~/.bashrc
121121
$ source ~/.bashrc
122122
```
123123

124-
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:
124+
Running the ISA test don't need 8G memory, so you can configure the `memory size` to reduce the simulation memory usage. Achieving that, you need to type `make menuconfig` as follow:
125125

126126
```bash
127127
$ cd dependency/NEMU
128128
$ make menuconfig
129129
```
130-
> NOTE: if you encount `Your display is too small to run Menuconfig!` error, you need to resize the terminal to match need as the console output: `It must be at least 19 lines by 80 columns`.
130+
> NOTE: if you encounter `Your display is too small to run Menuconfig!` error, you need to resize the terminal to match need as the console output: `It must be at least 19 lines by 80 columns`.
131131
132132
<p align="center">
133133
<img src="https://raw.githubusercontent.com/microdynamics-cpu/tree-core-cpu-res/main/nemu-build.png"/>
@@ -149,7 +149,7 @@ Usually, 256MB memory address space is enough for simulation. You need to switch
149149
Last, remember to type `Save` button in bottom menu to save the `.config` file. Then, type `Exit` to exit the menuconfig.
150150

151151
### Compile runtime libraries
152-
If you already run above commands correctly, you need to compile runtime libraries as follow:
152+
If you already run above commands correctly, you can compile runtime libraries as follow:
153153

154154
```bash
155155
$ cd ../../
@@ -173,6 +173,14 @@ After you modify the processor design, you need to run recursive unit test to gu
173173
$ make unit-tests
174174
```
175175

176+
The unit tests display the progress, testcase name, PASS or FAIL and ipc value.
177+
<p align="center">
178+
<img src="https://raw.githubusercontent.com/microdynamics-cpu/tree-core-cpu-res/main/isa-unit-test.png"/>
179+
<p align="center">
180+
<em>TreeCoreL2's unit test result</em>
181+
</p>
182+
</p>
183+
176184
First, Running unit test need to download `mill` from github. If you cannot access the github correctly, you need to type below commands to configure `mill` manually:
177185

178186
```bash
@@ -182,13 +190,6 @@ $ mv ~/.cache/mill/download/0.9.9-assembly ~/.cache/mill/download/0.9.9 # change
182190
$ chmod +x ~/.cache/mill/download/0.9.9
183191
```
184192

185-
<p align="center">
186-
<img src="https://raw.githubusercontent.com/microdynamics-cpu/tree-core-cpu-res/main/isa-unit-test.png"/>
187-
<p align="center">
188-
<em>The result of unit test</em>
189-
</p>
190-
</p>
191-
192193
### Software test
193194
```bash
194195
$ make

0 commit comments

Comments
 (0)