You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
13
13
14
-
git clone git://github.com/flow/flow-commons.git
14
+
git clone git://github.com/flow/commons.git
15
15
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).
17
17
18
18
## Dependencies
19
19
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
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.
37
37
38
38
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.
39
39
@@ -48,60 +48,50 @@ Are you a talented programmer looking to contribute some code? We'd love the hel
48
48
49
49
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!
50
50
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 repoto keep up-to-date with the latest Flow development!
52
52
53
53
## 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:
55
55
56
56
<dependency>
57
57
<groupId>com.flowpowered</groupId>
58
58
<artifactId>flow-commons</artifactId>
59
59
<version>0.1.0-SNAPSHOT</version>
60
60
</dependency>
61
61
62
-
If you do not already have the required repo in your repository list, you will need to add this as well:
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).
84
76
85
77
## 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).
87
79
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.
89
81
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.
91
83
92
84
## Version Control
93
85
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.
94
86
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.
98
88
99
89
## Legal Stuff
100
90
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.
101
91
102
92
## Credits
103
93
*[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/).
0 commit comments