aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorQuey-Liang Kao <s101062801@m101.nthu.edu.tw>2015-10-22 01:10:05 +0800
committerQuey-Liang Kao <s101062801@m101.nthu.edu.tw>2015-10-22 01:10:05 +0800
commit01a0ac4928c2e89796e845f961f7deef20f1f044 (patch)
treeb84a1d92cd107528f69f7834b3ba8d610e424560 /README.md
parentd8c1ab8fe08f90cd2e282e13628923136098a3a1 (diff)
downloadriscv-tools-01a0ac4928c2e89796e845f961f7deef20f1f044.zip
riscv-tools-01a0ac4928c2e89796e845f961f7deef20f1f044.tar.gz
riscv-tools-01a0ac4928c2e89796e845f961f7deef20f1f044.tar.bz2
Broken in-document links, mistake, style fix
There are many broken links in the third part of the manual, which are fixed now. Right before the "Help!" section, there was a command: spike +disk=root.bin vmlinux which should be spike +disk=root.bin bbl vmlinux and now it is fixed as well. Finally about style, I think that the references provided originally in subsection 10 of Linux manual are actually of a whole-project scope, and thus can be move up a level.
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 10 insertions, 10 deletions
diff --git a/README.md b/README.md
index a253285..af5d9c7 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
riscv-tools [![Build Status](https://travis-ci.org/riscv/riscv-tools.svg?branch=master)](https://travis-ci.org/riscv/riscv-tools)
===========================================================================
-Three guides are available for this repo:
+This repo provides guides and references:
1. [Quickstart](#quickstart)
@@ -9,6 +9,7 @@ Three guides are available for this repo:
3. [The Linux/RISC-V Installation Manual](#linuxman)
+4. [References](#references)
@@ -281,17 +282,16 @@ website](http://ocf.berkeley.edu/~qmn/linux/install.html)
1. Introduction
2. Table of Contents
-3. [Meta-installation Notes](#meta-installation-notes)
-4. [Installing the Toolchain](#installing-toolchain)
+3. [Meta-installation Notes](#meta-installation-notes-linux)
+4. [Installing the Toolchain](#installing-toolchain-linux)
5. [Building the Linux Kernel](#building-linux)
6. [Building BusyBox](#building-busybox)
7. [Creating a Root Disk Image](#creating-root-disk)
-8. ["Help! It doesn't work!"](#help-it-doesnt-work)
+8. ["Help! It doesn't work!"](#help-it-doesnt-work-linux)
9. [Optional Commands](#optional-commands)
-10. [References](#references)
-## <a name="meta-installation-notes"></a>Meta-installation Notes
+## <a name="meta-installation-notes-linux"></a>Meta-installation Notes
### Running Shell Commands
@@ -341,7 +341,7 @@ not necessary.
-## <a name="installing-toolchain"></a> Installing the Toolchain (11.81 + &epsilon; SBU)
+## <a name="installing-toolchain-linux"></a> Installing the Toolchain (11.81 + &epsilon; SBU)
Let's start with the directory in which we will install our
tools. Find a nice, big expanse of hard drive space, and let's call that
@@ -424,7 +424,7 @@ handle 16 make jobs (or conversely, it can handle more), edit
Since we only need to build a few tools, we will use a
modified build script, listed in its entirety below. Remember that we'll build
`riscv64-unknown-linux-gnu-gcc` shortly afterwards. If you want to build the full
-toolchain for later use, see <a href="#full-toolchain-build">here</a>.
+toolchain for later use, see <a href="#full-toolchain-build-linux">here</a>.
[basic-build.sh contents]
@@ -718,7 +718,7 @@ execution. We will need to load in the root disk image through the
`+disk` argument to `spike` as well. The command looks
like this:
- $ spike +disk=root.bin vmlinux
+ $ spike +disk=root.bin bbl vmlinux
`vmlinux` is the name of the compiled Linux kernel binary.
@@ -739,7 +739,7 @@ symbolic links to BusyBox applets. Otherwise, it will generate several
(harmless) warnings in each subsequent boot.
-## <a name="help-it-doesnt-work"></a> "Help! It doesn't work!"
+## <a name="help-it-doesnt-work-linux"></a> "Help! It doesn't work!"
I know, I've been there too. Good luck!