From 3c72f24f6c4dd7000868e2281926edffba52cb49 Mon Sep 17 00:00:00 2001
From: Michael Stack <stack@apache.org>
Date: Sat, 30 Oct 2010 22:30:54 +0000
Subject: [PATCH] HBASE-2672 README.txt should contain basic information like
 how to run or build HBase

git-svn-id: https://svn.apache.org/repos/asf/hbase/trunk@1029215 13f79535-47bb-0310-9956-ffa450edef68
---
 CHANGES.txt |  2 ++
 README.txt  | 31 ++++++++++++++++++++++++++++++-
 2 files changed, 32 insertions(+), 1 deletion(-)

diff --git a/CHANGES.txt b/CHANGES.txt
index 11336455d55..87390969827 100644
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -635,6 +635,8 @@ Release 0.21.0 - Unreleased
                znode location not deleted yet, and try to update META
                location in ROOT
    HBASE-2006  Documentation of hbase-site.xml parameters
+   HBASE-2672  README.txt should contain basic information like how to run
+               or build HBase
 
 
   IMPROVEMENTS
diff --git a/README.txt b/README.txt
index c9683121b95..7cc60da8078 100644
--- a/README.txt
+++ b/README.txt
@@ -1 +1,30 @@
-See the docs directory or http://hbase.org
+Apache HBase [1] is an open-source, distributed, versioned, column-oriented
+store modeled after Google' Bigtable: A Distributed Storage System for
+Structured Data by Chang et al.[2]  Just as Bigtable leverages the distributed
+data storage provided by the Google File System, HBase provides Bigtable-like
+capabilities on top of Apache Hadoop [3].
+
+To get started using HBase, the full documentation for this release can be
+found under the doc/ directory that accompanies this README.  Using a browser,
+open the docs/index.html to view the project home page (or browse to [1]).
+The hbase 'book' at docs/book.html has a 'quick start' section and is where you
+should being your exploration of the hbase project.
+
+The latest HBase can be downloaded from an Apache Mirror [4].
+
+The source code can be found at [5]
+
+The HBase issue tracker is at [6]
+
+Apache HBase is made available under the Apache License, version 2.0 [7]
+
+The HBase mailing lists and archives are listed here [8].
+
+1. http://hbase.apache.org
+2. http://labs.google.com/papers/bigtable.html
+3. http://hadoop.apache.org
+4. http://www.apache.org/dyn/closer.cgi/hbase/
+5. http://hbase.apache.org/docs/current/source-repository.html
+6. http://hbase.apache.org/docs/current/issue-tracking.html
+7. http://hbase.apache.org/docs/current/license.html
+8. http://hbase.apache.org/docs/current/mail-lists.html