|
1 | | -Caustic |
2 | | -===== |
3 | | -OpenGL rendering library developed for the Spout Platform |
| 1 | +# Caustic [][License] [][Donate] [](https://travis-ci.org/flow/caustic) [](https://coveralls.io/r/flow/caustic) |
| 2 | + |
| 3 | + |
| 4 | + |
| 5 | +## Getting Started |
| 6 | +* [Examples and code snippets](https://github.com/flow/examples/tree/master/caustic) |
| 7 | +* [Official documentation](#documentation) |
| 8 | +* [IRC support chat](http://kiwiirc.com/client/irc.esper.net/flow) |
| 9 | +* [Issues tracker](https://github.com/flow/caustic/issues) |
| 10 | + |
| 11 | +## Source Code |
| 12 | +The latest and greatest source can be found here on [GitHub](https://github.com/flow/caustic). If you are using Git, use this command to clone the project: |
| 13 | + |
| 14 | + git clone git://github.com/flow/caustic.git |
| 15 | + |
| 16 | +Or download the latest [development archive](https://github.com/flow/caustic/archive/develop.zip) or the latest [stable archive](https://github.com/flow/caustic/archive/master.zip). |
| 17 | + |
| 18 | +## Test Dependencies |
| 19 | +The following dependencies are only needed if you compiling the tests included with this project. Gotta test 'em all! |
| 20 | +* [junit:junit](https://oss.sonatype.org/#nexus-search;gav~junit~junit~~~) |
| 21 | + |
| 22 | +## Building from Source |
| 23 | +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. |
| 24 | + |
| 25 | +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. |
| 26 | + |
| 27 | +For Gradle, the command `gradlew` will build the project and will put the compiled JAR in `~/build/distributions`, and `gradlew install` will copy it to your local Maven repository. |
| 28 | + |
| 29 | +## Contributing |
| 30 | +Are you a talented programmer looking to contribute some code? We'd love the help! |
| 31 | + |
| 32 | +* Open a pull request with your changes, following our [guidelines and coding standards](CONTRIBUTING.md). |
| 33 | +* Please follow the above guidelines for your pull request(s) accepted. |
| 34 | +* For help setting up the project, keep reading! |
| 35 | + |
| 36 | +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! |
| 37 | + |
| 38 | +Don't forget to watch and star our repo to keep up-to-date with the latest Flow development! |
| 39 | + |
| 40 | +## Usage |
| 41 | +If you're using [Maven](https://maven.apache.org/download.html) to manage project dependencies, simply include the following in your `pom.xml` file: |
| 42 | + |
| 43 | + <dependency> |
| 44 | + <groupId>com.flowpowered</groupId> |
| 45 | + <artifactId>caustic</artifactId> |
| 46 | + <version>1.0.0-SNAPSHOT</version> |
| 47 | + </dependency> |
| 48 | + |
| 49 | +If you're using [Gradle](https://www.gradle.org/) to manage project dependencies, simply include the following in your `build.gradle` file: |
| 50 | + |
| 51 | + repositories { |
| 52 | + mavenCentral() |
| 53 | + } |
| 54 | + dependencies { |
| 55 | + compile 'com.flowpowered:caustic:1.0.0-SNAPSHOT' |
| 56 | + } |
| 57 | + |
| 58 | +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: |
| 59 | + |
| 60 | + https://oss.sonatype.org/content/groups/public/ |
| 61 | + |
| 62 | +If you'd prefer to manually import the latest .jar file, you can get it [here](https://github.com/flow/caustic/releases). |
| 63 | + |
| 64 | +## Documentation |
| 65 | +Want to get friendly with the project and put it to good use? Check out the latest [Javadocs](https://flowpowered.com/caustic). |
| 66 | + |
| 67 | +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. |
| 68 | + |
| 69 | +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. |
| 70 | + |
| 71 | +## Version Control |
| 72 | +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. |
| 73 | + |
| 74 | +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. |
| 75 | + |
| 76 | +## Legal Stuff |
| 77 | +Caustic 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. |
| 78 | + |
| 79 | +## Credits |
| 80 | +* [Spout](https://spout.org/) and contributors - *where we all began, and for much of the re-licensed code.* |
| 81 | +* All the people behind [Java](http://www.oracle.com/technetwork/java/index.html), [Maven](https://maven.apache.org/), and [Gradle](https://www.gradle.org/). |
| 82 | + |
| 83 | +[Donate]: https://flattr.com/submit/auto?user_id=spout&url=https://github.com/flow/caustic&title=Caustic&language=Java&tags=github&category=software |
| 84 | +[License]: https://tldrlegal.com/l/mit |
0 commit comments