summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDamien Le Moal <damien.lemoal@wdc.com>2018-12-25 09:37:48 +0300
committerDamien Le Moal <damien.lemoal@wdc.com>2018-12-25 09:37:48 +0300
commitd06dca9bcc470472337571c8ecc2742832713693 (patch)
tree90fc2c204a9a7e3d96804450f652f6f58494ec94 /README.md
parentfef12701fd9471a15d81d8d5b5aa8b6500c6435f (diff)
downloadopensbi-d06dca9bcc470472337571c8ecc2742832713693.tar.xz
Makefile: Rename CROSS_COMPILE to CROSS_COMPILE_PREFIX
Make it clear what this environment variable defines and update the README.md file to explain that. Signed-off-by: Damien Le Moal <damien.lemoal@wdc.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/README.md b/README.md
index 8d5b723..0588aa8 100644
--- a/README.md
+++ b/README.md
@@ -28,8 +28,9 @@ We can create three things using the RISC-V OpenSBI project:
How to Build?
-------------
-For cross-compiling, please ensure that CROSS_COMPILE environment
-variable is set before starting build system.
+For cross-compiling, the environment variable CROSS_COMPILE_PREFIX must be
+defined to specify the toolchain executable name prefix, e.g.
+"riscv64-unknown-elf-" for riscv64-unknown-elf-gcc.
The libplatsbi.a and firmwares are optional and only built when
`PLATFORM=<platform_subdir>` parameter is specified to top-level make.
@@ -78,4 +79,4 @@ We also prefer source level documentation, so wherever possible we describe
stuff directly in the source code. This helps us maintain source and its
documentation at the same place. For source level documentation we strictly
follow Doxygen style. Please refer [Doxygen manual]
-(http://www.stack.nl/~dimitri/doxygen/manual.html) for details. \ No newline at end of file
+(http://www.stack.nl/~dimitri/doxygen/manual.html) for details.