Skip to content

Commit c12667f

Browse files
committed
Update project build files and readme
1 parent 9d2b808 commit c12667f

5 files changed

Lines changed: 87 additions & 112 deletions

File tree

README.md

Lines changed: 23 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
Flow Commons [![License](http://img.shields.io/badge/license-MIT-lightgrey.svg?style=flat)][License] [![Flattr this](http://img.shields.io/badge/flattr-donate-lightgrey.svg?style=flat)][Donate] [![Build Status](http://img.shields.io/travis/flow/flow-commons/master.svg?style=flat)](https://travis-ci.org/flow/flow-commons) [![Coverage Status](http://img.shields.io/coveralls/flow/flow-commons/master.svg?style=flat)](https://coveralls.io/r/flow/flow-commons)
2-
==================
3-
Commons library for the Flow collection.
1+
# Flow Commons [![License](http://img.shields.io/badge/license-MIT-lightgrey.svg?style=flat)][License] [![Flattr this](http://img.shields.io/badge/flattr-donate-lightgrey.svg?style=flat)][Donate] [![Build Status](http://img.shields.io/travis/flow/commons/master.svg?style=flat)](https://travis-ci.org/flow/commons) [![Coverage Status](http://img.shields.io/coveralls/flow/commons/master.svg?style=flat)](https://coveralls.io/r/flow/commons)
2+
3+
A library for Java that provides re-usable components commonly used by Flow libraries.
44

55
## Getting Started
66
* [Examples and code snippets](https://github.com/flow/examples/tree/master/commons)
77
* [Official documentation](#documentation)
88
* [IRC support chat](http://kiwiirc.com/client/irc.esper.net/flow)
9-
* [Issues tracker](https://github.com/flow/flow-commons/issues)
9+
* [Issues tracker](https://github.com/flow/commons/issues)
1010

1111
## Source Code
12-
The latest and greatest source can be found here on [GitHub](https://github.com/flow/flow-commons). If you are using Git, use this command to clone the project:
12+
The latest and greatest source can be found here on [GitHub](https://github.com/flow/commons). If you are using Git, use this command to clone the project:
1313

14-
git clone git://github.com/flow/flow-commons.git
14+
git clone git://github.com/flow/commons.git
1515

16-
Or download the [latest zip archive](https://github.com/flow/flow-commons/archive/master.zip).
16+
Or download the [latest zip archive](https://github.com/flow/commons/archive/master.zip).
1717

1818
## Dependencies
1919
We love open-source libraries! This project uses are few of them to make things easier. If you aren't using Maven or Gradle, you'll need these!
@@ -33,7 +33,7 @@ The following dependencies are only needed if you compiling the tests included w
3333
* [org.powermock:powermock-module-junit4](https://oss.sonatype.org/#nexus-search;gav~org.powermock~powermock-module-junit4~~~)
3434

3535
## Building from Source
36-
This project can be built with the _latest_ [Java Development Kit](http://oracle.com/technetwork/java/javase/downloads) and [Maven](http://maven.apache.org/) or [Gradle](http://www.gradle.org/). Maven and Gradle are used to simplify dependency management, but using either of them is optional.
36+
This project can be built with the _latest_ [Java Development Kit](http://oracle.com/technetwork/java/javase/downloads) and [Maven](https://maven.apache.org/) or [Gradle](https://www.gradle.org/). Maven and Gradle are used to simplify dependency management, but using either of them is optional.
3737

3838
For Maven, the command `mvn clean package` will build the project and will put the compiled JAR in `target`, and `mvn clean install` will copy it to your local Maven repository.
3939

@@ -48,60 +48,50 @@ Are you a talented programmer looking to contribute some code? We'd love the hel
4848

4949
Love the project? Feel free to [donate] to help continue development! Flow projects are open-source and powered by community members, like yourself. Without you, we wouldn't be here today!
5050

51-
Please don't forget to follow and star our repo! Join our growing community to keep up to date with the latest Flow development.
51+
Don't forget to watch and star our repo to keep up-to-date with the latest Flow development!
5252

5353
## Usage
54-
If you're using [Maven](http://maven.apache.org/download.html) to manage project dependencies, simply include the following in your `pom.xml` file:
54+
If you're using [Maven](https://maven.apache.org/download.html) to manage project dependencies, simply include the following in your `pom.xml` file:
5555

5656
<dependency>
5757
<groupId>com.flowpowered</groupId>
5858
<artifactId>flow-commons</artifactId>
5959
<version>0.1.0-SNAPSHOT</version>
6060
</dependency>
6161

62-
If you do not already have the required repo in your repository list, you will need to add this as well:
63-
64-
<repository>
65-
<id>sonatype-nexus</id>
66-
<url>https://oss.sonatype.org/content/groups/public</url>
67-
</repository>
68-
69-
If you're using [Gradle](http://www.gradle.org/) to manage project dependencies, simply include the following in your `build.gradle` file:
62+
If you're using [Gradle](https://www.gradle.org/) to manage project dependencies, simply include the following in your `build.gradle` file:
7063

7164
repositories {
72-
mavenLocal()
7365
mavenCentral()
74-
maven {
75-
name = 'sonatype-nexus'
76-
url = 'https://oss.sonatype.org/content/groups/public/'
77-
}
7866
}
7967
dependencies {
8068
compile 'com.flowpowered:flow-commons:0.1.0-SNAPSHOT'
8169
}
8270

83-
If you'd prefer to manually import the latest .jar file, you can get it [here](https://github.com/flow/flow-commons/releases).
71+
If you plan on using snapshots and do not already have the snapshot repo in your repository list, you will need to add this as well:
72+
73+
https://oss.sonatype.org/content/groups/public/
74+
75+
If you'd prefer to manually import the latest .jar file, you can get it [here](https://github.com/flow/commons/releases).
8476

8577
## Documentation
86-
Want to get friendly with the project and put it to good use? Check out the latest [Javadocs](http://commons.flowpowered.com/).
78+
Want to get friendly with the project and put it to good use? Check out the latest [Javadocs](https://flowpowered.com/commons).
8779

88-
To generate the the Javadocs with Maven, use the `mvn javadoc:javadoc` command. To view the javadocs simply go to `target/site/apidocs/` and open `index.html` in a web browser.
80+
To generate Javadocs with Maven, use the `mvn javadoc:javadoc` command. To view the Javadocs simply go to `target/site/apidocs/` and open `index.html` in a web browser.
8981

90-
To generate Javadocs with Gradle, use the `gradlew javadoc` command. To view the javadocs simply go to `build/docs/javadoc/` and open `index.html` in a web browser.
82+
To generate Javadocs with Gradle, use the `gradlew javadoc` command. To view the Javadocs simply go to `build/docs/javadoc/` and open `index.html` in a web browser.
9183

9284
## Version Control
9385
We've adopted the [git flow branching model](http://nvie.com/posts/a-successful-git-branching-model/) in our projects. The creators of git flow released a [short intro video](http://vimeo.com/16018419) to explain the model.
9486

95-
The `master` branch is production-ready, but is not yet vetted for release. Only small patches and `hotfix/x` branches are pushed to `master`, and will always have a release version. The `develop` and `stage` branches are pre-production, and are where we push `feature/x` branches for testing.
96-
97-
Our release branches are named by version number, e.g. `1.0` and `1.1`. We begin release branches with a beta (b1) designation and progress them through release candidate to stable. All open source releases (included pre-releases) are tagged.
87+
The `master` branch is production-ready and contains the latest tagged releases. Before a release is made, it is stagged in `release/x` branches before being pushed and tagged in the `master` branch. Small patches from `hotfix/x` branches are also pushed to `master`, and will always have a release version. The `develop` branch is pre-production, and is where we push `feature/x` branches for testing.
9888

9989
## Legal Stuff
10090
Flow Commons is licensed under the [MIT License][License]. Basically, you can do whatever you want as long as you include the original copyright. Please see the `LICENSE.txt` file for details.
10191

10292
## Credits
10393
* [Spout](https://spout.org/) and contributors - *where we all began, and for much of the re-licensed code.*
104-
* All the people behind [Java](http://www.oracle.com/technetwork/java/index.html), [Maven](http://maven.apache.org/), and [Gradle](http://www.gradle.org/).
94+
* All the people behind [Java](http://www.oracle.com/technetwork/java/index.html), [Maven](https://maven.apache.org/), and [Gradle](https://www.gradle.org/).
10595

106-
[Donate]: https://flattr.com/submit/auto?user_id=spout&url=https://github.com/flow/flow-commons&title=Flow+Commons&language=Java&tags=github&category=software
107-
[License]: https://tldrlegal.com/license/mit-license
96+
[Donate]: https://flattr.com/submit/auto?user_id=spout&url=https://github.com/flow/commons&title=Flow+Commons&language=Java&tags=github&category=software
97+
[License]: https://tldrlegal.com/l/mit

build.gradle

Lines changed: 36 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22
defaultTasks 'clean', 'licenseFormat', 'build', 'install'
33

44
// Apply plugins
5-
apply plugin: 'cobertura'
6-
apply plugin: 'coveralls'
5+
apply plugin: 'java'
6+
apply plugin: 'cobertura' // Coveralls dependency
7+
apply plugin: 'com.github.kt3k.coveralls'
78
apply plugin: 'license'
89
apply plugin: 'maven'
910
apply plugin: 'signing'
@@ -15,12 +16,12 @@ archivesBaseName = 'flow-commons'
1516
version = '0.1.0-SNAPSHOT'
1617
ext.packaging = 'jar'
1718
ext.inceptionYear = '2013'
18-
ext.url = 'http://flowpowered.com'
19-
ext.description = 'Commons library for the Flow collection.'
19+
ext.url = 'https://flowpowered.com'
20+
ext.description = 'A library for Java that provides re-usable components commonly used by Flow libraries.'
2021

2122
// Organization information
22-
ext.organization = 'Spout LLC'
23-
ext.organizationUrl = 'https://spout.org'
23+
ext.organization = 'Flow Powered'
24+
ext.organizationUrl = 'https://flowpowered.com'
2425

2526
// Build properties
2627
ext.buildNumber = project.hasProperty('buildNumber') ? buildNumber : '0'
@@ -34,13 +35,13 @@ buildscript {
3435
mavenCentral()
3536
maven {
3637
name = 'sonatype-nexus'
37-
url = 'https://oss.sonatype.org/content/groups/public'
38+
url = 'https://oss.sonatype.org/content/groups/public/'
3839
}
3940
}
4041
dependencies {
41-
classpath 'nl.javadude.gradle.plugins:license-gradle-plugin:0.9.0'
42-
classpath 'org.kt3k.gradle.plugin:coveralls-gradle-plugin:0.5.0'
43-
classpath 'net.saliman:gradle-cobertura-plugin:2.2.4' // Coveralls plugin dependency
42+
classpath 'net.saliman:gradle-cobertura-plugin:2.2.5' // Coveralls dependency
43+
classpath 'nl.javadude.gradle.plugins:license-gradle-plugin:0.10.0'
44+
classpath 'org.kt3k.gradle.plugin:coveralls-gradle-plugin:2.0.1'
4445
}
4546
}
4647

@@ -50,23 +51,23 @@ repositories {
5051
mavenCentral()
5152
maven {
5253
name = 'sonatype-nexus'
53-
url = 'https://oss.sonatype.org/content/groups/public'
54+
url = 'https://oss.sonatype.org/content/groups/public/'
5455
}
5556
}
5657

5758
// Project dependencies
5859
dependencies {
59-
compile 'com.flowpowered:flow-math:0.1.0-SNAPSHOT'
60-
compile 'com.github.wolf480pl:jline-log4j2-appender:1.0.0-SNAPSHOT'
60+
compile 'com.flowpowered:flow-math:1.0.0'
61+
compile 'com.github.wolf480pl:jline-log4j2-appender:1.0.0'
6162
compile 'jline:jline:2.12'
6263
compile 'net.sf.trove4j:trove4j:3.0.3'
6364
compile 'org.apache.commons:commons-lang3:3.3.2'
64-
compile 'org.slf4j:slf4j-api:1.7.7'
65+
compile 'org.slf4j:slf4j-api:1.7.8'
6566
compile 'uk.org.lidalia:lidalia-slf4j-ext:1.0.0'
66-
testCompile 'junit:junit:4.11'
67+
testCompile 'junit:junit:4.12'
6768
testCompile 'org.hamcrest:hamcrest-library:1.3'
68-
testCompile 'org.powermock:powermock-api-mockito:1.5.5'
69-
testCompile 'org.powermock:powermock-module-junit4:1.5.5'
69+
testCompile 'org.powermock:powermock-api-mockito:1.6.0'
70+
testCompile 'org.powermock:powermock-module-junit4:1.6.0'
7071
}
7172

7273
// Filter, process, and include resources
@@ -108,6 +109,15 @@ jar.manifest.mainAttributes(
108109
'Specification-Version': version + '+' + ciSystem + '-b' + buildNumber + '.git-' + commit,
109110
'Specification-Vendor': organization + ' - ' + organizationUrl)
110111

112+
// Javadoc doclint configuration
113+
if (JavaVersion.current().isJava8Compatible()) {
114+
allprojects {
115+
tasks.withType(Javadoc) {
116+
options.addStringOption('Xdoclint:none', '-quiet')
117+
}
118+
}
119+
}
120+
111121
// Coveralls report configuration
112122
cobertura.coverageFormats = ['html', 'xml'] // Coveralls requires xml format
113123

@@ -166,15 +176,15 @@ uploadArchives {
166176
description project.ext.description
167177

168178
scm {
169-
connection 'scm:git:git://github.com/flow/flow-commons.git'
170-
developerConnection 'scm:git:ssh://git@github.com:flow/flow-commons.git'
171-
url 'https://github.com/flow/flow-commons'
179+
connection 'scm:git:git://github.com/flow/commons.git'
180+
developerConnection 'scm:git:ssh://git@github.com:flow/commons.git'
181+
url 'https://github.com/flow/commons'
172182
}
173183

174184
licenses {
175185
license {
176186
name 'MIT License'
177-
url 'https://tldrlegal.com/license/mit-license'
187+
url 'https://tldrlegal.com/l/mit'
178188
distribution 'repo'
179189
}
180190
}
@@ -185,6 +195,11 @@ uploadArchives {
185195
}
186196

187197
developers {
198+
developer {
199+
id 'DDoS'
200+
name 'Aleksi Sapon'
201+
email 'qctechs@gmail.com'
202+
}
188203
developer {
189204
id 'kitskub'
190205
name 'Jack Huey'

gradle.properties

Lines changed: 0 additions & 5 deletions
This file was deleted.

gradle/wrapper/gradle-wrapper.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@ distributionBase=GRADLE_USER_HOME
22
distributionPath=wrapper/dists
33
zipStoreBase=GRADLE_USER_HOME
44
zipStorePath=wrapper/dists
5-
distributionUrl=http\://services.gradle.org/distributions/gradle-2.0-bin.zip
5+
distributionUrl=http\://services.gradle.org/distributions/gradle-2.0-all.zip

0 commit comments

Comments
 (0)