Markdownified, updated README.

git-svn-id: svn+ssh://src.earth.threerings.net/nenya/trunk@1150 ed5b42cb-e716-0410-a449-f6a68f950b19
2011-04-06 22:53:40 +00:00
parent 8a951b218f
commit 81822f6cf9
2 changed files with 82 additions and 63 deletions
@@ -0,0 +1,82 @@
+The Nenya library
+=================
+
+The Nenya library provides various facilities for making networked multiplayer
+games. Its various packages include:
+
+* geom, util - basic tools for doing data structure manipulation and some
+  geometry math
+* resource - tools for bundling, deploying and managing media (images,
+  sounds, etc.) with a game
+* media - a framework for doing "active" rendering in Java
+* media.image - tools for loading, caching, manipulating and displaying images
+* media.sound - tools for loading, caching, and playing audio
+* media.animation, media.sprite - works in concert with the active
+  rendering system and provides tools for defining and manipulating
+  sprites (graphical entities that follow paths) and animations
+  (graphical entities that affect the display in other ways)
+* miso - a framework for defining and displaying isometrically rendered scenes
+* cast - a framework for defining and using recolorable, composited
+  characters with different poses and actions
+
+[Javadoc documentation](http://threerings.github.com/nenya/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
+--------
+
+The library is built using [Ant](http://ant.apache.org/).
+
+Invoke ant with any of the following targets:
+
+    all: builds the distribution files and javadoc documentation
+    compile: builds only the class files (dist/classes)
+    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 Nenya Java and
+ActionScript artifacts are maintained here. To add a Nenya dependency to a
+Maven project, add the following to your `pom.xml`:
+
+    <repositories>
+      <repository>
+        <id>ooo-repo</id>
+        <url>http://threerings.github.com/maven-repo</url>
+      </repository>
+    </repositories>
+    <dependencies>
+      <dependency>
+        <groupId>com.threerings</groupId>
+        <artifactId>nenya</artifactId>
+        <version>1.2</version>
+      </dependency>
+    </dependencies>
+
+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 pre-built binaries, those can be had here:
+
+* [nenya-1.2.jar](http://threerings.github.com/nenya/maven/com/threerings/nenya/1.2/nenya-1.2.jar)
+* [nenyalib-1.2.swc](http://threerings.github.com/nenya/maven/com/threerings/nenyalib/1.2/nenyalib-1.2.swc)
+
+Distribution
+------------
+
+The Nenya library is released under the LGPL. The most recent version of the
+library is available at http://github.com/threerings/nenya/.
+
+Contact
+-------
+
+Questions, comments, and other worldly endeavors can be handled via the [Three
+Rings Libraries](http://groups.google.com/group/ooo-libs) Google Group.
+
+Nenya is actively developed by the scurvy dogs at
+[Three Rings](http://www.threerings.net) Contributions are welcome.