aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRafael Sene <rafael@riscv.org>2023-04-27 12:23:25 -0300
committerGitHub <noreply@github.com>2023-04-27 12:23:25 -0300
commitd7d3601234a223c30370277739db4af27861452a (patch)
tree67c49096698658cddba45e9e17eaf2acecfbf196 /README.md
parent0751594996d9153ef1c5e4a9a1d6a5e42a92c792 (diff)
downloadriscv-isa-manual-d7d3601234a223c30370277739db4af27861452a.zip
riscv-isa-manual-d7d3601234a223c30370277739db4af27861452a.tar.gz
riscv-isa-manual-d7d3601234a223c30370277739db4af27861452a.tar.bz2
Update README.md
This PR updates README by adding a new build status and hyperlinks for the links. Signed-off-by: Rafael Sene <rafael@riscv.org>
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 16 insertions, 18 deletions
diff --git a/README.md b/README.md
index 6be9ad0..51e756f 100644
--- a/README.md
+++ b/README.md
@@ -1,30 +1,28 @@
-RISC-V Instruction Set Manual [![Build Status](https://app.travis-ci.com/riscv/riscv-isa-manual.svg?branch=master)](https://app.travis-ci.com/riscv/riscv-isa-manual)
-=============================
+# RISC-V Instruction Set Manual
-This repository contains the LaTeX source for the Privileged RISC-V Instruction Set Manual and the AsciiDoc source for the Unprivileged RISC-V Instruction Set Manual. The preface of each document indicates the version of each standard that has been formally ratified by RISC-V International.
+[![RISC-V ISA Build](https://github.com/riscv/riscv-isa-manual/actions/workflows/isa-build.yml/badge.svg)](https://github.com/riscv/riscv-isa-manual/actions/workflows/isa-build.yml)
-This work is licensed under a Creative Commons Attribution 4.0 International License. See the LICENSE file for details.
+This repository contains the source files for the RISC-V Instruction Set Manual, which is comprised of the Privileged RISC-V Instruction Set Manual (LaTeX) and the Unprivileged RISC-V Instruction Set Manual (AsciiDoc). The preface of each document indicates the version of each standard that has been formally ratified by RISC-V International.
+
+This work is licensed under a [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/). See the [LICENSE](LICENSE) file for details.
+
+The RISC-V Instruction Set Manual is organized into the following volumes:
-The Manual is split up into the following volumes:
- Volume I: User-Level ISA
- Volume II: Privileged Architecture
-**Official versions** of the specifications are available at
-https://riscv.org/specifications/
-
-**Compiled versions of the most recent drafts** of the specifications are available at
-https://github.com/riscv/riscv-isa-manual/releases/latest
+## Official and Draft Versions
-**Older official versions** of the specifications are available at
-https://github.com/riscv/riscv-isa-manual/releases/tag/archive
+- **Official versions** of the specifications are available at the [RISC-V International website](https://riscv.org/specifications/).
+- **Compiled versions of the most recent drafts** of the specifications can be found on the [GitHub releases page](https://github.com/riscv/riscv-isa-manual/releases/latest).
+- **Older official versions** of the specifications are archived at the [GitHub releases archive](https://github.com/riscv/riscv-isa-manual/releases/tag/archive).
-The canonical list of **open-source RISC-V implementations' marchid CSR values**
-is available at https://github.com/riscv/riscv-isa-manual/blob/main/marchid.md
+The canonical list of **open-source RISC-V implementations' marchid CSR values** is available in the [marchid.md file](https://github.com/riscv/riscv-isa-manual/blob/main/marchid.md).
-**Contributing**
+## Contributing
-To contribute to this documentation, please see the Documentation Developer's Guide here: https://github.com/riscv/docs-dev-guide
+If you would like to contribute to this documentation, please refer to the [Documentation Developer's Guide](https://github.com/riscv/docs-dev-guide).
-The recommended PDF Build method is to use the Docker Image as described here: https://github.com/riscv/riscv-docs-base-container-image
+The recommended method for building the PDF files is to use the Docker Image, as described in the [RISC-V Docs Base Container Image repository](https://github.com/riscv/riscv-docs-base-container-image).
-Alternative Build methods such as local builds and GitHub Action builds are also available as described in the Documentation Developer's Guide.
+Alternative build methods, such as local builds and GitHub Action builds, are also available and described in the Documentation Developer's Guide.