From 1cb299165c859533e22f2ed05eb2abd5071544df Mon Sep 17 00:00:00 2001 From: Priyansh Singh Date: Thu, 31 Mar 2022 07:35:40 -0400 Subject: Fixed minor documentation issues Fixed whitespace and punctuation issues, added a name to a link, and fixed a typo. --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 40284fed5b98..1cb56d0e82bb 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ take a look at the ## Getting Started with the LLVM System -Taken from https://llvm.org/docs/GettingStarted.html. +Taken from [here](https://llvm.org/docs/GettingStarted.html). ### Overview @@ -20,10 +20,10 @@ Welcome to the LLVM project! The LLVM project has multiple components. The core of the project is itself called "LLVM". This contains all of the tools, libraries, and header files needed to process intermediate representations and convert them into -object files. Tools include an assembler, disassembler, bitcode analyzer, and -bitcode optimizer. It also contains basic regression tests. +object files. Tools include an assembler, disassembler, bitcode analyzer, and +bitcode optimizer. It also contains basic regression tests. -C-like languages use the [Clang](http://clang.llvm.org/) front end. This +C-like languages use the [Clang](http://clang.llvm.org/) frontend. This component compiles C, C++, Objective-C, and Objective-C++ code into LLVM bitcode -- and from there into object files, using LLVM. @@ -100,13 +100,13 @@ This is an example work-flow and configuration to get and build the LLVM source: * CMake will generate targets for each tool and library, and most LLVM sub-projects generate their own ``check-`` target. - * Running a serial build will be **slow**. To improve speed, try running a + * Running a serial build will be **slow**. To improve speed, try running a parallel build. That's done by default in Ninja; for ``make``, use the option ``-j NNN``, where ``NNN`` is the number of parallel jobs to run. In most cases, you get the best performance if you specify the number of CPU threads you have. On some Unix systems, you can specify this with ``-j$(nproc)``. - * For more information see [CMake](https://llvm.org/docs/CMake.html) + * For more information see [CMake](https://llvm.org/docs/CMake.html). Consult the [Getting Started with LLVM](https://llvm.org/docs/GettingStarted.html#getting-started-with-llvm) -- cgit v1.2.1