You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@accumulo.apache.org by el...@apache.org on 2013/12/30 03:37:47 UTC
[2/4] git commit: ACCUMULO-2100 Update the README to be a bit clearer
on what to invoke
ACCUMULO-2100 Update the README to be a bit clearer on what to invoke
Project: http://git-wip-us.apache.org/repos/asf/accumulo-instamo-archetype/repo
Commit: http://git-wip-us.apache.org/repos/asf/accumulo-instamo-archetype/commit/9635d127
Tree: http://git-wip-us.apache.org/repos/asf/accumulo-instamo-archetype/tree/9635d127
Diff: http://git-wip-us.apache.org/repos/asf/accumulo-instamo-archetype/diff/9635d127
Branch: refs/heads/ACCUMULO-2100-cleanup
Commit: 9635d127c70cca24635fb11e839c3d03d1688ebb
Parents: fd94162
Author: Josh Elser <jo...@gmail.com>
Authored: Sun Dec 29 21:26:55 2013 -0500
Committer: Josh Elser <jo...@gmail.com>
Committed: Sun Dec 29 21:26:55 2013 -0500
----------------------------------------------------------------------
.../resources/archetype-resources/README.md | 25 ++++++++++++++++----
1 file changed, 21 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/accumulo-instamo-archetype/blob/9635d127/src/main/resources/archetype-resources/README.md
----------------------------------------------------------------------
diff --git a/src/main/resources/archetype-resources/README.md b/src/main/resources/archetype-resources/README.md
index bfd0f61..a5cd80d 100644
--- a/src/main/resources/archetype-resources/README.md
+++ b/src/main/resources/archetype-resources/README.md
@@ -21,18 +21,21 @@ Instamo
Introduction
-----------
-Instamo makes it easy to write some code and run it against a local, transient
+Instamo makes it easy to run some simple applications against a local, transient
[Accumulo](http://accumulo.apache.org) instance in minutes. No setup or
installation is required. This is possible if Java and Maven are already
installed by following the steps below.
+
+Build the code
+--------------
+
```
-vim src/test/java/${package}/ExampleAccumuloUnitTest.java
mvn package
```
-The maven package command will run the unit test. After packing the code, you
-can also run one of the below applications.
+The Maven package command will run the unit test. After packing the code, you
+can also run one of the following applications.
Map Reduce
----------
@@ -55,3 +58,17 @@ shell against a local Accumulo instance.
```
mvn exec:exec -P shell
```
+
+Writing your own
+----------------
+
+The ExampleAccumuloUnitTest class (src/test/java/ExampleAccumuloUnitTest.java)
+is a great place to begin writing your first code to run against Accumulo. The
+test currently creates some data about people.
+
+Each row contains information about a person, notably the friends and enemies of
+that person. The test case has a TODO comment for where you can try to find the
+common enemies between Alice and Bob.
+
+This test class is also a great starting point to write and read your own data
+to Accumulo.