[llvm] r282525 - [lit] Add instructions to run lit's test suite

[Daniel Dunbar via llvm-commits]

Author: ddunbar
Date: Tue Sep 27 13:58:50 2016
New Revision: 282525

URL: http://llvm.org/viewvc/llvm-project?rev=282525&view=rev
Log:
[lit] Add instructions to run lit's test suite

 - Patch by Brian Gesiak.
 
 - https://reviews.llvm.org/D24968

Modified:
    llvm/trunk/utils/lit/README.txt

Modified: llvm/trunk/utils/lit/README.txt
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/utils/lit/README.txt?rev=282525&r1=282524&r2=282525&view=diff
==============================================================================
--- llvm/trunk/utils/lit/README.txt (original)
+++ llvm/trunk/utils/lit/README.txt Tue Sep 27 13:58:50 2016
@@ -6,3 +6,19 @@ lit is a portable tool for executing LLV
 summarizing their results, and providing indication of failures. lit is designed
 to be a lightweight testing tool with as simple a user interface as possible.
 
+=====================
+ Contributing to lit
+=====================
+
+Please read the TODO file in this directory for ideas on what to work on.
+Before submitting patches, run the test suite to ensure nothing has regressed:
+
+    # From within your LLVM source directory.
+    utils/lit/lit.py \
+        --path /path/to/your/llvm/build/bin \
+        utils/lit/tests
+
+Note that lit's tests depend on 'not' and 'FileCheck', LLVM utilities.
+You will need to have built LLVM tools in order to run lit's test suite
+successfully.
+