riscv.vim git · master

Document where the syntax comes from

Kyle Laker · 2022-05-01 18:08 · 20ad5788c88939e0a05eff47e80559a9b3c57405

 README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/README.md b/README.md
index eff0db8..d391362 100644
--- a/README.md
+++ b/README.md
@@ -18,6 +18,25 @@ Put all files in your vim directory (such as `~/.vim/` or `~/.config/nvim/`)
 
 2. Install with `:PlugInstall`
 
+## Syntax Support
+
+The syntax highlighting within this plugin is based on several sources.
+Primarily, the latest versions of the [The RISC-V ISA Specification][spec],
+and specifically [Volume I: Unprivileged ISA v. 201912123][vol1] and
+[Volume II: Privileged Architecture v. 20211203][vol2]. Additionally, the
+[RISC-V Assembly Programmer's Manual][riscv-asm] is used as a reference for
+things not covered by the specification itself.
+
+[spec]: https://riscv.org/technical/specifications/
+[vol1]: https://github.com/riscv/riscv-isa-manual/releases/download/Ratified-IMAFDQC/riscv-spec-20191213.pdf
+[vol2]: https://github.com/riscv/riscv-isa-manual/releases/download/Priv-v1.12/riscv-privileged-20211203.pdf
+[riscv-asm]: https://github.com/riscv-non-isa/riscv-asm-manual/blob/master/riscv-asm.md
+
+It is a goal to support any syntax that has been changed or renamed (such as
+the `fmv.x.s` instruction) and syntax from drafts that may have real-world
+usage, though support for these may not be as complete. Contributions to add
+these are welcome.
+
 ## Usage
 
 Save your files with a .S extension or execute `set ft=riscv`.