summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFlorian Hahn <flo@fhahn.com>2019-12-02 15:46:47 +0000
committerFlorian Hahn <flo@fhahn.com>2019-12-02 15:47:15 +0000
commiteffcdc3a82f2a32829170e7f7a2ff3d7853b612d (patch)
tree721caff59aa54d55d5b822c4af3cc2c651050eec /README.md
parentaca7aab90d79df08ecadde798e2172f4995ab601 (diff)
downloadllvm-effcdc3a82f2a32829170e7f7a2ff3d7853b612d.tar.gz
Add contributing info to CONTRIBUTING.md and README.md
As discussed on llvm-dev [1], this patch adds a brief CONTRIBUTING.md to the top-level of the repo, with a pointer to Contributing.html. This should make it easier to discover the contributing information and also be highlighted in the Github UI. It also updates README.md to link to Contributing.html. [1] http://lists.llvm.org/pipermail/llvm-dev/2019-November/137141.html Reviewers: tonic, rnk, jhenderson, meikeb Reviewed By: rnk, jhenderson, meikeb Differential Revision: https://reviews.llvm.org/D70743
Diffstat (limited to 'README.md')
-rw-r--r--README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/README.md b/README.md
index c8013e0426bd..da06ed76b8ad 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,11 @@ This directory and its subdirectories contain source code for LLVM,
a toolkit for the construction of highly optimized compilers,
optimizers, and runtime environments.
+The README briefly describes how to get started with building LLVM.
+For more information on how to contribute to the LLVM project, please
+take a look at the
+[Contributing to LLVM](https://llvm.org/docs/Contributing.html) guide.
+
## Getting Started with the LLVM System
Taken from https://llvm.org/docs/GettingStarted.html.