Moved project info into README, Markdownified.

2013-09-02 09:50:38 -07:00
parent 050c14844e
commit c8305e023e
2 changed files with 74 additions and 23 deletions
@@ -1,23 +0,0 @@
-What is it?
-----------
-
-Getdown (yes, it's the funky stuff) aims to provide a system for downloading
-and installing a collection of files on a user's machine and upgrading those
-files as needed. Though just any collection of files would do, Getdown is
-mainly intended for the distribution and maintenance of the collection of files
-that make up an application.
-
-See the Google Code project for documentation and other information:
-
-http://code.google.com/p/getdown
-
-Building
--------
-
-Getdown is built with Maven in the standard ways. Invoke the following
-commands, for fun and profit:
-
-% mvn compile  # builds the classes
-% mvn test     # builds and runs the unit tests
-% mvn package  # builds and creates jar file
-% mvn install  # builds, jars and installs in your local Maven repository
@@ -0,0 +1,74 @@
+== What is it? ==
+
+Getdown (yes, it's the funky stuff) aims to provide a system for downloading and installing a
+collection of files on a user's machine and upgrading those files as needed. Though just any
+collection of files would do, Getdown is mainly intended for the distribution and maintenance of
+the collection of files that make up a Java application.
+
+It was designed as a replacement for [http://java.sun.com/products/javawebstart/ Java Web Start]
+due to limitations in Java Web Start's architecture which are outlined in the [Rationale rationale]
+section.
+
+== How do I use it? ==
+
+A tutorial and more detailed specification are available from the [Documentation] page. Questions
+can be posted to the [OOO Libs Google group].
+
+== How does it work? ==
+
+The main design and operation of Getdown is detailed on the [Design design] page. You can also
+browse the [javadoc documentation] and [source code] if you're interested in implementation
+details.
+
+== Where can I see it in action? ==
+
+Getdown was originally written by developers at [OOO](http://www.threerings.net/) for the
+deployment of their Java-based massively multiplayer games. Try out any of the following games to
+see it in action:
+
+  * [Puzzle Pirates](http://www.puzzlepirates.com/) - OOO
+  * [Bang! Howdy](http://banghowdy.com) - OOO
+  * [Spiral Knights](http://spiralknights.com) - OOO
+  * [Tribal Trouble 2](http://www.tribaltrouble2.com/) - Oddlabs
+
+Getdown is implemented in Java, but certainly can be used to deploy non-Java-based applications.
+Doing so would be a little crazy since you may have to install a JVM on the user's machine (if they
+don't already have one installed), which is a ~7MB download. This isn't so bad if you're already
+installing a Java application and must have a JVM, but it's a little crazy if the JVM is only used
+for your installer. It is probably possible to compile Getdown with
+[GCJ](http://gcc.gnu.org/java/), which would make Getdown a viable choice for non-Java
+applications.
+
+== Obtaining Getdown ==
+
+The latest version of Getdown can be obtained thusly:
+
+  * Download the pre-built jar file from Maven Central: [getdown-1.3.1.jar](http://repo2.maven.org/maven2/com/threerings/getdown/1.3.1/getdown-1.3.1.jar)
+  * Obtain the jar artifact via Maven with the following identifier: `com.threerings:getdown:1.3.1`.
+  * [Check out the code](https://github.com/threerings/getdown) and build it yourself.
+
+You can also:
+
+  * View the [javadoc documentation] online.
+  * Browse the [source code] online.
+
+
+== Building ==
+
+Getdown is built with Maven in the standard ways. Invoke the following commands, for fun and
+profit:
+
+```
+% mvn compile  # builds the classes
+% mvn test     # builds and runs the unit tests
+% mvn package  # builds and creates jar file
+% mvn install  # builds, jars and installs in your local Maven repository
+```
+
+== Discussion ==
+
+Feel free to pop over to the [OOO Libs Google Group] to ask questions and get (and give) answers.
+
+[OOO Libs Google group]: http://groups.google.com/group/ooo-libs
+[source code]: https://github.com/threerings/getdown/tree/master/src/main/java/com/threerings/getdown/launcher
+[javadoc documentation]: http://getdown.googlecode.com/svn/apidocs/overview-summary.html