From 7f339bede33982af0bfc54d022974d495d8403db Mon Sep 17 00:00:00 2001 From: Michael Bayne Date: Wed, 6 Apr 2011 22:18:22 +0000 Subject: [PATCH] Further enhancement to the README. git-svn-id: svn+ssh://src.earth.threerings.net/vilya/trunk@1079 c613c5cb-e716-0410-b11b-feb51c14d237 --- README.md | 57 +++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 45 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 98a08613..f526c4a4 100644 --- a/README.md +++ b/README.md @@ -4,20 +4,22 @@ The Vilya library The Vilya library provides various facilities for making networked multiplayer games. Its various packages include: -* whirled - builds on the crowd framework and defines a scene graph with +* [whirled] - builds on the crowd framework and defines a scene graph with portals to move between scenes and provides hooks for distributing and updating scene data (for example isometric rendering information) over the network -* parlor - builds upon the crowd framework to create the notion of a game with +* [parlor] - builds upon the crowd framework to create the notion of a game with players and provides tools for making turn based games -* puzzle - builds on the parlor and media frameworks to provide tools for +* [puzzle] - builds on the parlor and media frameworks to provide tools for implementing puzzle games in a networked environment -* micasa - builds on the parlor framework to provide lobbies and matchmaking +* [micasa] - builds on the parlor framework to provide lobbies and matchmaking for multiplayer games -Documentation is somewhat sparse at the moment, but inspection of the code in -the `src/test/java/` directory shows examples of use of many features of the -library. +[Javadoc documentation](http://threerings.github.com/vilya/apidocs/) is provided. + +Tutorial-style documentation is somewhat sparse at the moment, but inspection +of the code in the `src/test/java/` directory shows examples of use of many +features of the library. Building -------- @@ -31,6 +33,33 @@ Invoke ant with any of the following targets: javadoc: builds only the javadoc documentation (dist/docs) dist: builds the distribution jar files (dist/*.jar) +Artifacts +--------- + +A Maven repository containing released versions of the Vilya Java and +ActionScript artifacts are maintained here. To add a Vilya dependency to a +Maven project, add the following to your `pom.xml`: + + + + vilya-repo + http://threerings.github.com/vilya/maven + + + + + com.threerings + vilya + 1.3 + + + +To add it to an Ivy, SBT, or other Maven repository using project, simply +remove the vast majority of the boilerplate above. + +If you prefer to download a jar file, that can be found +[here](http://threerings.github.com/vilya/maven/com/threerings/vilya/). + Distribution ------------ @@ -40,9 +69,13 @@ library is available at http://github.com/threerings/vilya. Contact ------- -Questions, comments, contributions, and other worldly endeavors can be handled -in the [Google Group for Three Rings -libraries](http://groups.google.com/group/ooo-libs). +Questions, comments, and other worldly endeavors can be handled via the [Three +Rings Libraries](http://groups.google.com/group/ooo-libs) Google Group. -Vilya is actively developed by the scurvy dogs at [Three Rings Design, -Inc.](http://www.threerings.net) Contributions are welcome. +Vilya is actively developed by the scurvy dogs a +[Three Rings](http://www.threerings.net) Contributions are welcome. + +[whirled]: http://threerings.github.com/vilya/apidocs/com/threerings/whirled/package-summary.html +[parlor]: http://threerings.github.com/vilya/apidocs/com/threerings/parlor/package-summary.html +[puzzle]: http://threerings.github.com/vilya/apidocs/com/threerings/puzzle/package-summary.html +[micasa]: http://threerings.github.com/vilya/apidocs/com/threerings/micasa/package-summary.html