ethereumj-personal

History

Chris Beams 9127c01890 Polish formatting The sources affected by this commit have drifted in style since earlier polishing commits such as `f34d1f4` and `a155518`. The shared IDEA style configuration file can help avoid this drift in the future. Simply run Code->Reformat Code at the project level prior to committing. Note that this code style configuration is not perfect, and not every change it makes should be checked in. The ideal is to simply always write code that conforms to the style conventions, but the automated settings are there as a helping hand when necessary. The churn caused by drifting style and the commits that fix it damage the utility of git over time. Reviewing changes, analyzing history, surgically reverting commits, and many other use cases with git simply do not work as well when styles get mixed and fixed. Let's work toward a common style.		2015-01-20 12:20:09 +01:00
..
src	Polish formatting	2015-01-20 12:20:09 +01:00
README.md	Update README.md	2015-01-14 22:30:21 -08:00
build.gradle	Polish formatting	2015-01-20 12:20:09 +01:00
track-untrack-local.bat	Strip trailing whitespace	2014-12-26 09:45:14 +01:00

README.md

ethereum-core

Include ethereum-core in your project

For snapshot builds:

Add https://oss.jfrog.org/libs-snapshot/ as a repository to your build script
Add a dependency on org.ethereum:ethereumj-core:${VERSION}, where ${VERSION} is of the form 0.8.1-SNAPSHOT.

Example:

<repository>
    <id>jfrog-snapshots</id>
    <name>oss.jfrog.org</name>
    <url>https://oss.jfrog.org/libs-snapshot/</url>
    <snapshots><enabled>true</enabled></snapshots>
</repository>
<!-- ... -->
<dependency>
   <groupId>org.ethereum</groupId>
   <artifactId>ethereumj-core</artifactId>
   <version>0.8.1-SNAPSHOT</version>
</dependency>

For release builds:

There are no release builds at this time. Use snapshots in the meantime.

Examples

See 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

Simply push to master, and the Travis CI build will take care of the rest. To publish manually instead, just run ../gradlew publish. Where the artifacts are published depends on the value of the version property in the root build.gradle file. Snapshots (version values ending in -SNAPSHOT) will be published to oss.jfrog.org, while releases will be published to Bintray (and subsequently to JCenter). You must be a member of the ethereum Bintray organization and you must supply bintrayUser and bintrayKey properties to the Gradle build in order to authenticate against these repositories. Configure these properties in your $HOME/.gradle/gradle.properties for greatest convenience and security.