Whamcloud - gitweb
LU-17000 lnet: fix various bugs in lib-move.c
[fs/lustre-release.git] / README
diff --git a/README b/README
index 8f274ba..8c862c2 100644 (file)
--- a/README
+++ b/README
@@ -1,13 +1,88 @@
-Instructions for building, configuring and running Lustre can be found at:
-    http://wiki.whamcloud.com/display/PUB/Submitting+Changes
-and:
-    http://wiki.whamcloud.com/display/PUB/Using+Gerrit
+  _           _
+ | |         | |
+ | |_   _ ___| |_ _ __ ___
+ | | | | / __| __| '__/ _ \
+ | | |_| \__ | |_| | |  __/
+ |_|\__,_|___/\__|_|  \___|
+
+Lustre is an open-source, distributed parallel file system designed for
+scalability, high-performance, and high-availability.
+
+Lustre is purpose-built to provide a coherent, global POSIX-compliant
+namespace for very large scale computer clusters, including the world's
+largest supercomputer platforms.
+
+It can support hundreds of petabytes of data storage and hundreds of
+gigabytes per second in simultaneous, aggregate throughput.
+
+
+More information about Lustre:
+    http://www.lustre.org/
+Many resources for using, configuring, and troubleshooting Lustre are at:
+    http://wiki.lustre.org/
+
++-----------+
+| Community |
++-----------+
+
+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
+
+To report bugs, please visit:
+    https://jira.whamcloud.com/
+
+The official repository is hosted at:
+    https://git.whamcloud.com/
+
++----------------------+
+| Building and Testing |
++----------------------+
+
+Detailed instructions for building, configuring and running Lustre:
+    http://wiki.lustre.org/Compiling_Lustre
+and
+    https://wiki.whamcloud.com/display/PUB/Getting+started+with+Lustre.
+
+
+To build Lustre:
+
+    bash autogen.sh
+    ./configure
+    make
+
+To play with a test Lustre filesystem:
+
+    ./lustre/tests/llmount.sh
+
+To clean up:
+
+    ./lustre/tests/llmountcleanup.sh
+
++--------------+
+| Contributing |
++--------------+
+
+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.whamcloud.com/display/PUB/Coding+Guidelines
+    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:
 
-    cp build/{prepare-,}commit-msg .git/hooks/
+    cd .git/hooks
+    ln -s ../../contrib/git-hooks/{prepare-,}commit-msg ./
+    cd ../..