From 7d007dc32922326fbb1bae9463479139b885f3e4 Mon Sep 17 00:00:00 2001 From: Mike Hearn Date: Mon, 27 Jun 2011 14:16:38 +0000 Subject: [PATCH] Update README to talk about Maven. --- README | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/README b/README index be977820e..5d5aa2b89 100644 --- a/README +++ b/README @@ -1,12 +1,21 @@ -To get started, ensure you have the latest JDK installed and then just run "ant". +To get started, ensure you have the latest JDK installed, and download Maven from: -- A JAR will be placed in dist/ -- JavaDocs will be placed in docs/ -- Unit tests will be run + http://maven.apache.org/ + +Then run "mvn clean package" to compile the software. You can also run "mvn site:site" to generate a website with +useful information like JavaDocs. The outputs are under the target/ directory. Now ensure you're running a BitCoin node locally and run the example app: cd out java com.google.bitcoin.examples.PingService -It will print a BitCoin address. If you send coins to it, you should get them back a few minutes later when a block is solved. \ No newline at end of file +It will download the block chain and eventually print a BitCoin address. If you send coins to it, +you should get them back a few minutes later when a block is solved. + +Note that if you connect to a node that is itself downloading the block chain, you will see very slow progress (1 +block per second or less). Find a node that isn't heavily loaded to connect to. + +If you get a SocketDisconnectedException, the node you've connected to has its max send buffer set to low +(unfortunately the default is too low). Connect to a node that has a bigger send buffer, +settable by passing -maxsendbuffer=25600 to the Bitcoin C++ software. \ No newline at end of file