AfflictionNetworks/getdown
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Trimmed the readme and added build instructions.

Browse Source
This commit is contained in:
Michael Bayne
2010-09-21 06:35:16 +00:00
parent 646dc2bdf0
commit 4de928424e
1 changed files with 10 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README
+10 -62
View File
@@ -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 mainly intended for the distribution and maintenance of the collection of files
that make up an application. that make up an application.
It was designed as a replacement for Java Web Start due to limitations in Java See the Google Code project for documentation and other information:
Web Start's architecture which are outlined in the rationale section.
How does it work? http://code.google.com/p/getdown
-----------------
The main design and operation of Getdown is detailed on the design page:
http://www.threerings.net/code/getdown/design.html Building
--------
You can also browse the javadoc documentation if you're interested in Getdown is built with Maven in the standard ways. Invoke the following
implementation details. commands, for fun and profit:
How do I use it? % mvn compile # builds the classes
---------------- % mvn test # builds and runs the unit tests
Tutorials for creating a sample project will be made available shortly. For % mvn package # builds and creates jar file
now, check the examples on the design page (URL above) and post questions to % mvn install # builds, jars and installs in your local Maven repository
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
<mdb@threerings.net>. Contributions and bug fixes are always welcome.