sqoop-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cheol...@apache.org
Subject git commit: SQOOP-753: Update top level README file
Date Wed, 12 Dec 2012 22:20:58 GMT
Updated Branches:
  refs/heads/sqoop2 9ab7ea6ee -> e93fbb189


SQOOP-753: Update top level README file

(Jarek Jarcec Cecho via Cheolsoo Park)


Project: http://git-wip-us.apache.org/repos/asf/sqoop/repo
Commit: http://git-wip-us.apache.org/repos/asf/sqoop/commit/e93fbb18
Tree: http://git-wip-us.apache.org/repos/asf/sqoop/tree/e93fbb18
Diff: http://git-wip-us.apache.org/repos/asf/sqoop/diff/e93fbb18

Branch: refs/heads/sqoop2
Commit: e93fbb18991a32b8dca4e52d13c4bc5549d5d000
Parents: 9ab7ea6
Author: Cheolsoo Park <cheolsoo@apache.org>
Authored: Wed Dec 12 14:20:22 2012 -0800
Committer: Cheolsoo Park <cheolsoo@apache.org>
Committed: Wed Dec 12 14:20:22 2012 -0800

----------------------------------------------------------------------
 README.txt |   39 ++++++++++++++++++++++++++++++---------
 1 files changed, 30 insertions(+), 9 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/sqoop/blob/e93fbb18/README.txt
----------------------------------------------------------------------
diff --git a/README.txt b/README.txt
index 80d421e..b7508a1 100644
--- a/README.txt
+++ b/README.txt
@@ -1,13 +1,34 @@
-----
-The sqoop2 branch is an experimental branch for the development of the
-next major release of Sqoop.
+= Welcome to Sqoop
 
-For more details please see the following JIRA issue:
-https://issues.apache.org/jira/browse/SQOOP-365
-----
+Apache Sqoop is a tool designed for efficiently transferring bulk data between
+Apache Hadoop and structured datastores such as relational databases. You can use
+Sqoop to import data from external structured datastores into Hadoop Distributed
+File System or related systems like Hive and HBase. Conversely, Sqoop can be used
+to extract data from Hadoop and export it to external structured datastores such
+as relational databases and enterprise data warehouses.
 
-Welcome to Sqoop!
+== Documentation
 
-This document outlines how to build the source code.
+Sqoop ships with documentation, please check module "docs" for additional materials.
 
-TODO: add details
+More documentation is available online on Sqoop home page:
+
+http://sqoop.apache.org/
+
+== Compiling Sqoop
+
+Sqoop uses the Maven build system, and it can be compiled and built running the
+following commands:
+
+  mvn compile # Compile project
+  mvn package # Build source artifact
+  mvn package -Pbinary # Build binary artifact
+
+Sqoop currently supports multiple Hadoop distributions. In order to compile Sqoop
+against a specific Hadoop version, please specify the hadoop.profile property in
+Maven commands. For example:
+
+  mvn package -Pbinary -Dhadoop.profile=100
+
+Please refer to the Sqoop documentation for a full list of supported Hadoop
+distributions and values of the hadoop.profile property.


Mime
View raw message