Whamcloud - gitweb
LU-14105 lfsck: don't LBUG() on disk data
[fs/lustre-release.git] / README
diff --git a/README b/README
index e69de29..ea46659 100644 (file)
--- a/README
+++ b/README
@@ -0,0 +1,33 @@
+Many resources for using, configuring, and troubleshooting Lustre are at:
+    http://wiki.lustre.org/
+
+The low-volume list for announcements of new releases is at:
+    http://lists.lustre.org/listinfo.cgi/lustre-announce-lustre.org
+The generic Lustre discussion mailing list is available at:
+    http://lists.lustre.org/listinfo.cgi/lustre-discuss-lustre.org
+The Lustre developer mailing list is at:
+    http://lists.lustre.org/pipermail/lustre-devel-lustre.org
+
+Instructions for building, configuring and running Lustre:
+    http://wiki.lustre.org/Compiling_Lustre
+and
+    https://wiki.whamcloud.com/display/PUB/Getting+started+with+Lustre.
+
+Instructions for contributing patches for Lustre:
+    http://wiki.lustre.org/Submitting_Changes
+and
+    http://wiki.lustre.org/Using_Gerrit
+
+The Lustre Coding Style Guidelines can be found at:
+    http://wiki.lustre.org/Lustre_Coding_Style_Guidelines
+
+The Lustre Test Script Style Guidelines can be found at:
+    http://wiki.lustre.org/Lustre_Script_Coding_Style
+
+In order to improve the quality of patches submitted to the Lustre tree,
+it is possible to automatically check every patch and commit against the
+Lustre Coding Guidelines.  To do this, run in the top-level lustre/ tree:
+
+    cd .git/hooks
+    ln -s ../../contrib/git-hooks/{prepare-,}commit-msg ./
+    cd ../..