altcoinj/README.md

[![Build Status](https://travis-ci.org/dogecoin/libdohj.svg?branch=master)](https://travis-ci.org/dogecoin/libdohj)

### Welcome to libdohj

The libdohj library is a lightweight wrapper library around the bitcoinj Java library,
enabling support for Dogecoin (pull requests for support for other altcoins would
be welcomed).

### Getting started

To get started, it is best to have the latest JDK and Maven installed. The HEAD of the `master` branch contains the latest development code.
You should be familiar with bitcoinj first, as this library simply adds minor
changes to extend bitcoinj. Generally using libdohj is equivalent to using
bitcoinj, except with different network parameters (reflecting Dogecoin consensus
in place of Bitcoin).

Be aware however that altcoin blocks have their own class, AltcoinBlock, which
adds support for features such as AuxPoW.

#### Building from the command line

To perform a full build use
```
mvn clean package
```
You can also run
```
mvn site:site
```
to generate a website with useful information like JavaDocs.

The outputs are under the `target` directory.

#### Building from an IDE

Alternatively, just import the project using your IDE. [IntelliJ](http://www.jetbrains.com/idea/download/) has Maven integration built-in and has a free Community Edition. Simply use `File | Import Project` and locate the `pom.xml` in the root of the cloned project source tree.
Add build status image 2016-01-08 20:37:00 +00:00			`[![Build Status](https://travis-ci.org/dogecoin/libdohj.svg?branch=master)](https://travis-ci.org/dogecoin/libdohj)`

Update README.md to match libdohj not dogecoinj 2015-08-23 11:31:46 +00:00			`### Welcome to libdohj`
Improved README to use Markdown and provide additional instructions for people getting started 2014-08-27 09:49:57 +00:00
Fix typo in build.md. 2015-10-18 19:04:53 +00:00			`The libdohj library is a lightweight wrapper library around the bitcoinj Java library,`
Update README.md to match libdohj not dogecoinj 2015-08-23 11:31:46 +00:00			`enabling support for Dogecoin (pull requests for support for other altcoins would`
			`be welcomed).`
Improved README to use Markdown and provide additional instructions for people getting started 2014-08-27 09:49:57 +00:00
			`### Getting started`

Update README.md to match libdohj not dogecoinj 2015-08-23 11:31:46 +00:00			To get started, it is best to have the latest JDK and Maven installed. The HEAD of the `master` branch contains the latest development code.
			`You should be familiar with bitcoinj first, as this library simply adds minor`
			`changes to extend bitcoinj. Generally using libdohj is equivalent to using`
			`bitcoinj, except with different network parameters (reflecting Dogecoin consensus`
			`in place of Bitcoin).`

			`Be aware however that altcoin blocks have their own class, AltcoinBlock, which`
			`adds support for features such as AuxPoW.`
Improved README to use Markdown and provide additional instructions for people getting started 2014-08-27 09:49:57 +00:00
			`#### Building from the command line`

			`To perform a full build use`
			```
			`mvn clean package`
			```
			`You can also run`
			```
			`mvn site:site`
			```
			`to generate a website with useful information like JavaDocs.`

			The outputs are under the `target` directory.

			`#### Building from an IDE`

			Alternatively, just import the project using your IDE. [IntelliJ](http://www.jetbrains.com/idea/download/) has Maven integration built-in and has a free Community Edition. Simply use `File \| Import Project` and locate the `pom.xml` in the root of the cloned project source tree.