From 4de928424e7b7b14c42c33170950625073e5a04b Mon Sep 17 00:00:00 2001 From: Michael Bayne Date: Tue, 21 Sep 2010 06:35:16 +0000 Subject: [PATCH] Trimmed the readme and added build instructions. --- README | 72 ++++++++-------------------------------------------------- 1 file changed, 10 insertions(+), 62 deletions(-) diff --git a/README b/README index 1b181b6..13d86ed 100644 --- a/README +++ b/README @@ -7,69 +7,17 @@ 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. -It was designed as a replacement for Java Web Start due to limitations in Java -Web Start's architecture which are outlined in the rationale section. +See the Google Code project for documentation and other information: -How does it work? ------------------ -The main design and operation of Getdown is detailed on the design page: +http://code.google.com/p/getdown -http://www.threerings.net/code/getdown/design.html +Building +-------- -You can also browse the javadoc documentation if you're interested in -implementation details. +Getdown is built with Maven in the standard ways. Invoke the following +commands, for fun and profit: -How do I use it? ----------------- -Tutorials for creating a sample project will be made available shortly. For -now, check the examples on the design page (URL above) and post questions to -the Game Gardens forums: - -http://forums.gamegardens.com/discussion/mvnforum/listthreads?forum=4 - -How do I compile it? --------------------- -You will need to download the library dependencies which are enumerated in -lib/LIBS. And then you can use Ant to build Getdown like so: - -% ant dist (builds the main jar file) -% ant proguard (builds the dependency includede, deployment jar file) - -Is it free? ------------ -Yes! Getdown is released under a BSD license. The most recent version should -always be available here: - -http://www.threerings.net/code/getdown/ - -Where can I see it in action? ------------------------------ -Getdown was originally written by developers at Three Rings Design for the -deployment of their Java-based massively multiplayer game Puzzle Pirates. You -can download and install Puzzle Pirates or Bang! Howdy to see Getdown in use in -a production environment. - -Getting Getdown ---------------- -Getdown is available in source code form via Subversion: - -% svn checkout svn://code.threerings.net/getdown/trunk getdown - -Precompiled jar files are also available: - -* http://www.threerings.net/code/getdown/getdown/dist/getdown-pro.jar - - This version contains all dependencies and has been reduced in size using - Proguard. You can stick this into a distribution that uses JDK 1.5 and use it - directly. - -* http://www.threerings.net/code/getdown/getdown/dist/getdown-retro-pro.jar - - This version contains all dependencies and has been modified to be backwards - compatible with JDK 1.4 using Retroweaver. You can stick this into a - distribution that uses JDK 1.4 and use it directly. - -Getting Involved ----------------- -Check the forums listed above, or send email to Michael Bayne -. Contributions and bug fixes are always welcome. +% 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