Updated README #1
Conversation
README.md
Outdated
| @@ -1,4 +1,4 @@ | |||
| # RISC-V-Eklavya'23 | |||
| # RISC-V-CPU | |||
| --- | |||
|
|
|||
| #### The RISC-V CPU will be implemented with IMAF instruction extensions, and also verified using custom verification methods. | |||
There was a problem hiding this comment.
Let’s not talk about future objectives, and try to describe the CPU in its current. State. The first thing in a README should be describing what we have in the repository.
README.md
Outdated
| @@ -10,14 +10,45 @@ RISC-V is an instruction set architecture like ARM based on RISC (Reduced Instr | |||
|
|
|||
| Due to being open-source in nature, RISC-V provides a vital step in designing, building and testing new hardware without paying any license fees or royalties | |||
There was a problem hiding this comment.
Ok, will remove that section.
README.md
Outdated
| --- | ||
| ### How to compile the CPU and view simulation | ||
|
|
||
| First we need to write a C code for the operation we need to perform on our CPU(For example:- We have written a script that generates fibonacci series), |
There was a problem hiding this comment.
Why are you writing this para as “We”. Reword this paragraph simply as instructions.
“An example C program can be loaded on the CPU’s program memory for operations.”
“We provide an example code under sim/fibonacci.c for testing purposes."
README.md
Outdated
| -[Verilator](https://verilator.org/guide/latest/install.html) | ||
| -[Gtkwave](https://gtkwave.sourceforge.net/) | ||
|
|
||
| All the necessary commands have been added to the Makefile |
There was a problem hiding this comment.
Specify path of the makefile
| @@ -48,20 +79,21 @@ Following is the block diagram and workflow in simple terms of our CPU:- | |||
|  | |||
|
|
|||
|
|
|||
|  | |||
|
|
|||
| --- | |||
|
|
|||
| ### Tech Stack | |||
|
|
|||
| - Verilog | |||
| - Quartus Prime IDE | |||
There was a problem hiding this comment.
Remove this as we no longer use it.
README.md
Outdated
| - Lattice Framework | ||
| --- | ||
| ### Future Work | ||
| - [ ] Fix issues with Seven Segment Display | ||
| - [ ] Verify CPU output with every cases, possible, edge and false cases. | ||
| - [x] Verify CPU output with every cases, possible, edge and false cases. |
There was a problem hiding this comment.
Verification is not done. Ideally, there should be a script that will formally verify the CPU and display results.
There was a problem hiding this comment.
Please add instructions or a list of software which are needed to run the CPU. Provide links with instructions to install/build.
There was a problem hiding this comment.
I have added softwares in the Tech stack, should I bring it on top of the document?
Also links for installations are also given above in the form of hyperlinks
|
Pushed the suggested changes |
Changes made in README:-