summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAnup Patel <anup.patel@wdc.com>2018-12-28 11:50:25 +0300
committerAnup Patel <anup@brainfault.org>2018-12-31 07:03:04 +0300
commit5688b4d8fcd39eaf504e73279bbe42b9700369da (patch)
treeddf878c092880f8f9167b292e34f3a653f6fd242 /README.md
parent5959312a5c26df64ebfdd9b4d926e88cf3d87840 (diff)
downloadopensbi-5688b4d8fcd39eaf504e73279bbe42b9700369da.tar.xz
top: Minor typo fixes in top-level README.md
This patch does minor typo fixes in top-level README.md. Signed-off-by: Anup Patel <anup.patel@wdc.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 9 insertions, 12 deletions
diff --git a/README.md b/README.md
index 7b142d5..c38f543 100644
--- a/README.md
+++ b/README.md
@@ -4,10 +4,9 @@ RISC-V Open Source Supervisor Binary Interface (OpenSBI)
The **RISC-V Supervisor Binary Interface (SBI)** is a recommended
interface between:
-1. A pplatform specific firmware executed in M-mode and a general purpose
- OS hypervisor or bootloader executed in S-mode or HS-mode.
-2. A hypervisor executed in HS-mode and a general purpose OS or bootloader
- executed in VS-mode
+1. A platform specific firmware (M-mode) and a general purpose
+ OS or hypervisor or bootloader (S-mode or HS-mode).
+2. A hypervisor (HS-mode) and a general purpose OS or bootloader (VS-mode)
The *RISC-V SBI specification* is maintained as an independent project
by the RISC-V Foundation in [Github](https://github.com/riscv/riscv-sbi-doc)
@@ -59,17 +58,16 @@ Building and Installing platform specific *libsbi.a* and firmwares
------------------------------------------------------------------
The libplatsbi.a and firmware files are only built if the
-*PLATFORM=<platform path>* argument is specified on make command lines.
-*<platform path>* must specify the path to one of the leaf directories
-under the *platform* directory. For example, to compile the library and
-firmware for QEMU generic RISC-V *virt* machine, *<platform path>*
-should be *qemu/virt*.
+*`PLATFORM=<platform_subdir>`* argument is specified on make command lines.
+*`<platform_subdir>`* must specify the path to one of the leaf directories
+under the *`platform`* directory. For example, to compile the library and
+firmware for QEMU RISC-V *virt* machine, *`<platform_subdir>`*
+should be *`qemu/virt`*.
To build *libsbi, libplatsbi, and firmwares* for a specific platform, run:
```
make PLATFORM=<platform_subdir>
```
-
or
```
@@ -80,7 +78,6 @@ To install *libsbi, headers, libplatsbi, and firmwares*, run:
```
make PLATFORM=<platform_subdir> install
```
-
or
```
@@ -88,7 +85,7 @@ make PLATFORM=<platform_subdir> I=<install_directory> install`
```
In addition, platform specific make command-line options to top-level make
-,such as *PLATFORM_<xyz>* or *FW_<abc>* can also be specified. These
+, such as *PLATFORM_<xyz>* or *FW_<abc>* can also be specified. These
options are described under *docs/platform/<platform_name>.md* and
*docs/firmware/<firmware_name>.md*.