Skip to content

Commit

Permalink
fixed instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
alexholmes committed Jan 26, 2014
1 parent dff59f0 commit 5e0f8a3
Showing 1 changed file with 30 additions and 9 deletions.
39 changes: 30 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,22 +21,43 @@ Doing so will mean that running your first example is just three steps away:
2. Extract the contents ot the tarball, i.e. `tar -xzvf hip-<version>-package.tar.gz`
3. Run the "hello world" example, which is

```ruby
```bash
$ cd hip-<version>
$

# create two input files in HDFS
$ hadoop fs -mkdir -p hip1/input
$ echo "cat sat mat" | hadoop fs -put - hip1/input/1.txt
$ echo "dog lay mat" | hadoop fs -put - hip1/input/2.txt

# run the inverted index example
$ ./hip hip.ch1.InvertedIndexJob --input hip1/input --output hip1/output

# examine the results in HDFS
$ hadoop fs -cat hip1/output/part*
```
Click on the "releases" link

Done! The tarball also includes the sources and JavaDocs.

### Building your own distribution

To get started, simply:
Here you're going to checkout the trunk and then use Maven to run a build.

1. Checkout the code.

1. Download, and run `mvn package`.
2. Use the generated JAR `target/hadoop-utils-<version>.jar` in your application.
3. Understand the API's by reading the generated JavaDocs in `target/hadoop-utils-<version>-javadoc.jar`.
```bash
$ git co git@github.com:alexholmes/hiped2.git
```

2. Build the code and distribution tarball.

```bash
$ cd hiped2
$ mvn package
```

### To run the bundled utilities
The JAR's and tarball will be under the `target` directory.

Look at file [CLI.md](https://github.com/alexholmes/hadoop-utils/blob/master/CLI.md) for more details.
## What's next?

At this point check out the book for more examples and how you can execute them. Or if you find any issues then
please post them here - click on "Issues".

0 comments on commit 5e0f8a3

Please sign in to comment.