Skip to content

Commit

Permalink
Update readme.adoc
Browse files Browse the repository at this point in the history
Signed-off-by: Kersten Richter <[email protected]>
  • Loading branch information
kersten1 authored May 1, 2024
1 parent 52088e1 commit 24042b3
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions readme.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
# riscv-glossary

This contains an initial draft of a RISC-V glossary.
This repo contains the RISC-V glossary. The glossary includes RISC-V specific terms, definitions, and acronyms as well as some commonly used computer architecture definitions.

Over time, this glossary can become a resource for both contributors and for people who are learning about RISC-V and related technologies.
## How can I add or edit a term, defintion, or acronym?

Please feel free to suggest additions and modifications by creating issues.
You can add a term, definition, or acronym to the RISC-V glossary in the following ways.

1. Create a PR against the [glossary.adoc](https://github.com/riscv/riscv-glossary/blob/main/src/glossary.adoc) file with your proposed changes.
2. Open an issue against the RISC-V glossary repo from the [Issues](https://github.com/riscv/riscv-glossary/issues) tab. Click New Issue and then select the Glossary term requested template by clicking Get Started.
3. Posting in the [Sig Documentation](https://lists.riscv.org/g/sig-documentation) mailing list.
The Doc Sig work group will respond to your request.

0 comments on commit 24042b3

Please sign in to comment.