ethereumj-personal/ethereumj-core/README.md


## ethereum-core

### Include ethereum-core in your project

 1. Add http://dl.bintray.com/ethereum/maven as a repository to your build script
 2. Add a dependency on `org.ethereum:ethereumj:$version`, where `$version` is one of those listed at https://bintray.com/ethereum/maven/org.ethereum/view


### Examples

See [ethereumj-studio](../ethereumj-studio).


### Build from source

#### Compile, test and package

Run `./gradlew build`.

 - find jar artifacts at `build/libs`
 - find unit test and code coverage reports at `build/reports`

#### Run an ethereum node

 - run `./gradlew run`, or
 - build a standalone executable jar with `./gradlew shadow` and execute the `-all` jar in `build/libs` using `java -jar [jarfile]`.

#### Import sources into IntelliJ IDEA

Use IDEA 14 or better and import project based on Gradle sources.

Note that in order to build the project without errors in IDEA, you will need to run `gradle antlr4` manually.

#### Install artifacts into your local `~/.m2` repository

Run `./gradlew install`.

#### Publish ethereumj-core builds

_TODO: integrate bintray gradle plugin_
Create README.md 2014-09-10 05:34:45 +00:00
Port build from Maven to Gradle 2014-12-26 13:23:44 +00:00			`## ethereum-core`
Create README.md 2014-09-10 05:34:45 +00:00
Port build from Maven to Gradle 2014-12-26 13:23:44 +00:00			`### Include ethereum-core in your project`
Update README.md 2014-09-10 05:37:19 +00:00
Port build from Maven to Gradle 2014-12-26 13:23:44 +00:00			`1. Add http://dl.bintray.com/ethereum/maven as a repository to your build script`
			2. Add a dependency on `org.ethereum:ethereumj:$version`, where `$version` is one of those listed at https://bintray.com/ethereum/maven/org.ethereum/view
Update README.md 2014-09-10 05:37:19 +00:00
Update README.md 2014-09-10 05:41:46 +00:00
Port build from Maven to Gradle 2014-12-26 13:23:44 +00:00			`### Examples`
Update README.md 2014-09-10 05:41:46 +00:00
Port build from Maven to Gradle 2014-12-26 13:23:44 +00:00			`See [ethereumj-studio](../ethereumj-studio).`
Strip trailing whitespace 2014-12-26 08:36:37 +00:00

Port build from Maven to Gradle 2014-12-26 13:23:44 +00:00			`### Build from source`
Update README.md 2014-09-10 06:00:37 +00:00
Port build from Maven to Gradle 2014-12-26 13:23:44 +00:00			`#### Compile, test and package`
Strip trailing whitespace 2014-12-26 08:36:37 +00:00
Port build from Maven to Gradle 2014-12-26 13:23:44 +00:00			Run `./gradlew build`.
Strip trailing whitespace 2014-12-26 08:36:37 +00:00
Port build from Maven to Gradle 2014-12-26 13:23:44 +00:00			- find jar artifacts at `build/libs`
			- find unit test and code coverage reports at `build/reports`
Strip trailing whitespace 2014-12-26 08:36:37 +00:00
Port build from Maven to Gradle 2014-12-26 13:23:44 +00:00			`#### Run an ethereum node`

			- run `./gradlew run`, or
			- build a standalone executable jar with `./gradlew shadow` and execute the `-all` jar in `build/libs` using `java -jar [jarfile]`.

Introduce src/gen/java for generated sources Previously, sources generated from the serpent antlr grammar in ethereumj-core/src/main/antlr4 were output into the build/generated-src directory by default. This worked from the command line without issue, but caused issues within IDEA, because the entirety of the 'build' directory is excluded from compilation by default when working with a Gradle-based project in IDEA. This change simplifies the arrangement by writing these antlr-generated sources to the src/gen/java. A .gitignore file has been added to ensure that transient source files don't accidentally get checked in. A readme file has been added to explain the situation to the uninitiated. 2014-12-26 16:14:39 +00:00			`#### Import sources into IntelliJ IDEA`

			`Use IDEA 14 or better and import project based on Gradle sources.`

			Note that in order to build the project without errors in IDEA, you will need to run `gradle antlr4` manually.

Support installation of artifacts to local maven repo Apply Gradle's 'maven' plugin in order to support `./gradlew install` task, similar to `mvn install` for building and copying artifacts to the users local ~/.m2 repository. 2014-12-26 20:50:15 +00:00			#### Install artifacts into your local `~/.m2` repository

			Run `./gradlew install`.

Port build from Maven to Gradle 2014-12-26 13:23:44 +00:00			`#### Publish ethereumj-core builds`

			`_TODO: integrate bintray gradle plugin_`