Whamcloud - gitweb
LU-13090 utils: fix lfs_migrate -p for file with pool
[fs/lustre-release.git] / README
diff --git a/README b/README
index e69de29..bba4f76 100644 (file)
--- a/README
+++ b/README
@@ -0,0 +1,23 @@
+Instructions for building, configuring and running Lustre:
+    https://wiki.whamcloud.com/display/PUB/Building+Lustre+from+Source
+and
+    https://wiki.whamcloud.com/display/PUB/Getting+started+with+Lustre.
+
+Instructions for contributing patches for Lustre:
+    https://wiki.whamcloud.com/display/PUB/Submitting+Changes
+and
+    https://wiki.whamcloud.com/display/PUB/Using+Gerrit
+
+The Lustre Coding Style Guidelines can be found at:
+    https://wiki.whamcloud.com/display/PUB/Coding+Guidelines
+
+The Lustre Test Script Style Guidelines can be found at:
+    https://wiki.whamcloud.com/display/PUB/Test+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 ../..