diff --git a/COMPILING.txt b/COMPILING.adoc similarity index 100% rename from COMPILING.txt rename to COMPILING.adoc diff --git a/README.md b/README.md new file mode 100644 index 00000000..1ab2153b --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +[![Build Status](https://travis-ci.org/apache/sqoop.svg?branch=trunk)](https://travis-ci.org/apache/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 + +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/`. + +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). diff --git a/README.txt b/README.txt deleted file mode 100644 index c27d912e..00000000 --- a/README.txt +++ /dev/null @@ -1,46 +0,0 @@ - -= 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 - -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/+. - -If you got Sqoop in release form, documentation will already be built and -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 for information. - -== This is also an Asciidoc file! - -* Try running +asciidoc README.txt+ -* For more information about asciidoc, see http://www.methods.co.nz/asciidoc/ -