[PATCH] D122727: Improved Documentation Inclusivity

[Priyansh Singh via Phabricator via llvm-commits]

ps-19 created this revision.
ps-19 added reviewers: jyknight, jy7.yang, jyasskin, jyimusuuhilik, jyh, Dan, DaAnIV, danalbert, Danbab, danbeam, aaron.ballman, ktkachov.
Herald added a project: All.
ps-19 requested review of this revision.
Herald added a project: LLVM.

Primary Aim Of the Patch is:

Added more visibility in docs.
Removed Errors and grammatical mistakes.
Removed extra spaces and tabs created to make sample code and command error-less and concise.
Dear sir/mam,
I am new to LLVM and contribution here is complicated and different. I am working on a issue, so trying to understand, how to submit a patch using this contribution. Kindly merge the request. I am really good at coding i am coding since 14 yrs age, development and open source


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D122727

Files:
  README.md


Index: README.md
===================================================================
--- README.md
+++ README.md
@@ -11,7 +11,7 @@
 
 ## 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 @@
 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.
 
@@ -33,7 +33,7 @@
 
 ### Getting the Source Code and Building LLVM
 
-The LLVM Getting Started documentation may be out of date.  The [Clang
+The LLVM Getting Started documentation may be out of date. The [Clang
 Getting Started](http://clang.llvm.org/get_started.html) page might have more
 accurate information.
 
@@ -100,13 +100,13 @@
         * CMake will generate targets for each tool and library, and most
           LLVM sub-projects generate their own ``check-<project>`` 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)


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D122727.419117.patch
Type: text/x-patch
Size: 2396 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20220330/13f4d664/attachment.bin>