From b9c7a73898194aa36f94e156a3ec3ef36e332cb4 Mon Sep 17 00:00:00 2001 From: Szabolcs Vasas Date: Wed, 13 Mar 2019 10:49:56 +0100 Subject: [PATCH 1/5] readme --- README.txt => README.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) rename README.txt => README.md (74%) diff --git a/README.txt b/README.md similarity index 74% rename from README.txt rename to README.md index c27d912e..0053ce22 100644 --- a/README.txt +++ b/README.md @@ -1,11 +1,11 @@ +[![Build Status](https://travis-ci.org/apache/sqoop.svg?branch=trunk)](https://travis-ci.org/apache/sqoop) -= Welcome to Sqoop! +# Welcome to Sqoop! This is the Sqoop (SQL-to-Hadoop) tool. Sqoop allows easy imports and exports of data sets between databases and HDFS. - -== More Documentation +## More Documentation Sqoop ships with additional documentation: a user guide and a manual page. @@ -15,8 +15,7 @@ the documentation. It will be created in +build/docs/+. If you got Sqoop in release form, documentation will already be built and available in the +docs/+ directory. - -== Compiling Sqoop +## Compiling Sqoop Compiling Sqoop requires the following tools: @@ -33,14 +32,13 @@ Additionally, building the documentation requires these tools: * gzip To compile Sqoop, run +ant package+. There will be a fully self-hosted build -provided in the +build/sqoop-(version)/+ directory. +provided in the +build/sqoop-(version)/+ directory. You can build just the jar by running +ant jar+. -See the COMPILING.txt document for for information. +See the COMPILING.txt document for more information. -== This is also an Asciidoc file! +## This is also an Asciidoc file! * Try running +asciidoc README.txt+ * For more information about asciidoc, see http://www.methods.co.nz/asciidoc/ - From ce592b8a310c0a8920a489bbe218eb90ce1000a0 Mon Sep 17 00:00:00 2001 From: Szabolcs Vasas Date: Wed, 13 Mar 2019 10:53:01 +0100 Subject: [PATCH 2/5] Renaming COMPILING.txt to COMPILING.adoc --- COMPILING.txt => COMPILING.adoc | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename COMPILING.txt => COMPILING.adoc (100%) diff --git a/COMPILING.txt b/COMPILING.adoc similarity index 100% rename from COMPILING.txt rename to COMPILING.adoc From 80d3dde1c35f320be459d4e539115eb35e12cd43 Mon Sep 17 00:00:00 2001 From: Szabolcs Vasas Date: Wed, 13 Mar 2019 10:57:22 +0100 Subject: [PATCH 3/5] Unnecessary info is removed from README.md --- README.md | 34 ++++------------------------------ 1 file changed, 4 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 0053ce22..d878af6b 100644 --- a/README.md +++ b/README.md @@ -9,36 +9,10 @@ exports of data sets between databases and HDFS. Sqoop ships with additional documentation: a user guide and a manual page. -Asciidoc sources for both of these are in +src/docs/+. Run +ant docs+ to build -the documentation. It will be created in +build/docs/+. +Asciidoc sources for both of these are in `src/docs/`. Run `ant docs` to build +the documentation. It will be created in `build/docs/`. If you got Sqoop in release form, documentation will already be built and -available in the +docs/+ directory. +available in the `docs/` directory. -## Compiling Sqoop - -Compiling Sqoop requires the following tools: - -* Apache ant (1.9.7) -* Java JDK 1.8 - -Additionally, building the documentation requires these tools: - -* asciidoc -* make -* python 2.5+ -* xmlto -* tar -* gzip - -To compile Sqoop, run +ant package+. There will be a fully self-hosted build -provided in the +build/sqoop-(version)/+ directory. - -You can build just the jar by running +ant jar+. - -See the COMPILING.txt document for more information. - -## This is also an Asciidoc file! - -* Try running +asciidoc README.txt+ -* For more information about asciidoc, see http://www.methods.co.nz/asciidoc/ +For more information on compiling see [COMPILING.adoc](COMPILING.adoc) From 1e3980ccf08d2752d06538c957477a185423dfbd Mon Sep 17 00:00:00 2001 From: Szabolcs Vasas Date: Wed, 13 Mar 2019 11:01:39 +0100 Subject: [PATCH 4/5] An extra dot is added. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d878af6b..5afe7777 100644 --- a/README.md +++ b/README.md @@ -15,4 +15,4 @@ the documentation. It will be created in `build/docs/`. If you got Sqoop in release form, documentation will already be built and available in the `docs/` directory. -For more information on compiling see [COMPILING.adoc](COMPILING.adoc) +For more information on compiling see [COMPILING.adoc](COMPILING.adoc). From 0c6ec943c2024e4abf7ed887f08a9744fda6a53d Mon Sep 17 00:00:00 2001 From: Szabolcs Vasas Date: Wed, 13 Mar 2019 11:17:46 +0100 Subject: [PATCH 5/5] An extra whitespace is removed. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5afe7777..1ab2153b 100644 --- a/README.md +++ b/README.md @@ -15,4 +15,4 @@ the documentation. It will be created in `build/docs/`. If you got Sqoop in release form, documentation will already be built and available in the `docs/` directory. -For more information on compiling see [COMPILING.adoc](COMPILING.adoc). +For more information on compiling see [COMPILING.adoc](COMPILING.adoc).