ZYM/RISC-V-Simulator
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: detail about the compiling command

Browse Source
This commit is contained in:
DarkSharpness
2024-07-23 16:29:59 +08:00
parent 4e9af85b89
commit d3572cc9dc
1 changed files with 10 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/help.md
View File

@ -10,9 +10,11 @@ which can (hope so) save you from writing a lot of duplicated code.
## Requirements ## Requirements
`g++-12` or later. `-std=c++20` or `-std=c++2b`. `g++-12` or later, with flags `-std=c++20`.
e.g. `g++ -std=c++2b ...` e.g. `g++ -std=c++20 ...`
Your code may still run on `g++-11` or earlier, but we do not guarantee that.
## Include the library ## Include the library
@ -28,12 +30,17 @@ We strongly recommend you to include `include/tools.h` to simply include all the
We provide a debug mode, which will perform more checks in the code. To enable that, We provide a debug mode, which will perform more checks in the code. To enable that,
just define the macro `_DEBUG` before including the headers. just define the macro `_DEBUG` before including the headers.
You may also pass `-D _DEBUG` to the compiling command to define the macro. You may also pass `-D _DEBUG` to the compiler to define the macro,
or just define it in your code.
```cpp ```cpp
#define _DEBUG #define _DEBUG
``` ```
We **strongly recommend** you to enable the debug mode when you are developing your project.
e.g. `g++ -std=c++20 -D _DEBUG ...`
## Value types ## Value types
You may at first treat all these types as the verilog integers. You may at first treat all these types as the verilog integers.