-
Notifications
You must be signed in to change notification settings - Fork 305
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
improved readme #282
base: master
Are you sure you want to change the base?
improved readme #282
Conversation
README.md
Outdated
|
||
If you only want a specific artifact you can use one or more of the following targets : `c`, `rust`, `chisel`, `sverilog`, `latex` | ||
To generate specific artifacts, use one or more of the following targets: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Myrausman can we add a short text explaining how to set those options?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Myrausman take a look a the 2 initial comments.
git apply ../op.patch
../op.patch:381: trailing whitespace.
- Create the Extension File:
warning: 1 line adds whitespace errors.
Hi @rpsene, I've added an example for setting options and I'm using trunk for formatting—please let me know if the changes look good or if you'd prefer a different format. |
2a35a21
to
1230b82
Compare
c4e177a
to
8db3943
Compare
62960d6
to
b8b005b
Compare
b8b005b
to
cb74b74
Compare
Signed-off-by: Myrausman <[email protected]>
Signed-off-by: Myrausman <[email protected]>
Signed-off-by: Myrausman <[email protected]>
Signed-off-by: Myrausman <[email protected]>
cb74b74
to
a6b0b00
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #282 +/- ##
=======================================
Coverage 96.53% 96.53%
=======================================
Files 10 10
Lines 750 750
=======================================
Hits 724 724
Misses 26 26 ☔ View full report in Codecov by Sentry. 🚨 Try these New Features:
|
Improved README:
The following changes were made to the
riscv-opcodes
README file to enhance the overall readability and clarity, making it more approachable for both new and experienced contributors:Enhanced Section Organization:
Improved Project Structure Clarity:
File Naming Policy Explanation:
rv_x
,rv32_x
,rv64_x
,rv_x_y
, andunratified/
.Detailed Encoding Syntax:
Clear Workflow for parse.py:
parse.py
script was added, including a breakdown of the different phases (regular instructions, pseudo instructions, imported instructions) and the checks performed in each phase. This improves understanding of how the script processes instructions and generates artifacts.Artifact Generation Process:
parse.py
script and theMakefile
. This helps users understand the full scope of available artifacts and how to produce them.Simplified Debugging Instructions:
parse.py
have been made more prominent, helping users troubleshoot issues more effectively.Contribution Guidelines: