OSDN Git Service

Update README.md
authorbitiotic <github@bitiotic.com>
Thu, 21 Feb 2013 17:00:03 +0000 (09:00 -0800)
committerbitiotic <github@bitiotic.com>
Thu, 21 Feb 2013 17:59:18 +0000 (09:59 -0800)
Update compilation instructions and point off to documentation and
wiki pages for more details.
Update top-level headers to make them a bit more verbose

README.md

index d9d14b9..6936540 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,38 +2,44 @@
 \r
 Libgdx is a cross-platform Java game development framework based on \r
 OpenGL (ES) that works on Windows, Linux, Mac OS X, Android, your\r
-WebGL enabled browser and soon iOS.\r
+WebGL enabled browser and iOS.\r
 \r
-#### [Official Site][1]\r
-#### [Issues Tracker (Google Code)][3], include a link to your pull request if applicable\r
-#### [Wiki (Google Code)][4]\r
-\r
-#### [Forum][5] Come here to ask questions about Libgdx\r
-#### Join us on irc.freenode.net, #libgdx\r
-#### Follow us on Twitter [@badlogicgames][6]\r
-#### Follow our [blog][2] for the latest updates\r
+#### The [Libgdx Official Site][1] hosts downloads, documentation and contains useful links\r
+#### The [community-maintained wiki][4] hosted at Google Code will explain much of Libgdx\r
+#### Use the [Badlogic Forum][5] to ask questions about Libgdx\r
+#### Follow the [Badlogic Blog][2] for the latest Libgdx news\r
+#### Use the [Issue Tracker][3] to post concrete bug reports (with a pull request if possible)\r
+#### Chat with us on IRC at irc.freenode.net, #libgdx\r
+#### Follow [@badlogicgames][6] on Twitter\r
 \r
 ## Compiling the Code\r
 \r
-This project has a few [prerequisites][7] but primarily uses the ant build tool. If you wish to compile the code then just check it out and:\r
+Be sure to understand the [prerequisites][7] required for Libgdx.\r
+\r
+See [Running Demos &\r
+Tests][8] for\r
+instructions on getting the basics working with the source tree.\r
 \r
-    cd /path/to/libgdx\r
-    ant\r
+See the [Source Building wiki page][9] for instructions on building\r
+native code and building distribution images.\r
 \r
-And it should compile.\r
+You do not have to compile Libgdx, you can [download][A] official\r
+releases and nightly build snapshots from [libgdx.badlogicgames.com][A].\r
 \r
-## Examples\r
+## Libgdx Usage Examples\r
 \r
-There are a number of example games in the source. Some of them include:\r
+There are a number of example games included in the source. Some of them include:\r
 \r
  - metagun\r
  - superjumper\r
  - gdx-vertorpinball\r
  - rtm\r
  - very angry robots\r
+ - pax-britannica\r
 \r
 To see how to use libgdx you can either go to the [wiki][4] (which has plenty of good information) or read through\r
-these example projects. Once again, if you get stuck just drop in to the friendly [forums][5].\r
+these example projects.  The test cases in `tests/gdx-tests/` are another good source of sample code.\r
+Once again, if you get stuck just drop in to the friendly [forums][5].\r
 \r
  [1]: http://libgdx.badlogicgames.com\r
  [2]: http://www.badlogicgames.com\r
@@ -42,3 +48,6 @@ these example projects. Once again, if you get stuck just drop in to the friendl
  [5]: http://www.badlogicgames.com/forum\r
  [6]: http://www.twitter.com/badlogicgames\r
  [7]: http://code.google.com/p/libgdx/wiki/Prerequisits\r
+ [8]: http://code.google.com/p/libgdx/wiki/SourceRunningDemos\r
+ [9]: http://code.google.com/p/libgdx/wiki/SourceBuilding\r
+ [A]: http://libgdx.badlogicgames.com/download.html
\ No newline at end of file