summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorEbrahim Byagowi <ebrahim@gnu.org>2021-02-16 14:36:56 -0600
committerEvandro Menezes <evandro.menezes@sifive.com>2021-02-16 14:47:06 -0600
commit8eda10ca09c25f631d41f040137c89145bdcbc1a (patch)
tree6a12462c4edcd96a2009a978f6cb928ef0dd49a7 /README.md
parentb86dbe0c23e3d284699da551afc2ca9c634a6c62 (diff)
downloadllvm-8eda10ca09c25f631d41f040137c89145bdcbc1a.tar.gz
[doc] Use cmake's -S option to simplify the build instructions
Now that llvm's minimum version is 3.13.4 anyway and `-S` is introduced in the same version[1], let's use this little time saving option to simplify the build instructions. [1]: https://cgold.readthedocs.io/en/latest/glossary/-S.html Authored-By: Ebrahim Byagowi <ebrahim@gnu.org> Differential-Revision: https://reviews.llvm.org/D95049
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 2 insertions, 6 deletions
diff --git a/README.md b/README.md
index 6e02ee378eb3..e39bc2c000b9 100644
--- a/README.md
+++ b/README.md
@@ -50,11 +50,7 @@ This is an example work-flow and configuration to get and build the LLVM source:
* ``cd llvm-project``
- * ``mkdir build``
-
- * ``cd build``
-
- * ``cmake -G <generator> [options] ../llvm``
+ * ``cmake -S llvm -B build -G <generator> [options]``
Some common build system generators are:
@@ -85,7 +81,7 @@ This is an example work-flow and configuration to get and build the LLVM source:
* ``-DLLVM_ENABLE_ASSERTIONS=On`` --- Compile with assertion checks enabled
(default is Yes for Debug builds, No for all other build types).
- * ``cmake --build . [-- [options] <target>]`` or your build system specified above
+ * ``cmake --build build [-- [options] <target>]`` or your build system specified above
directly.
* The default target (i.e. ``ninja`` or ``make``) will build all of LLVM.