README.md

   1 # Libgdx\r
   2 \r
   3 Libgdx is a cross-platform Java game development framework based on \r
   4 OpenGL (ES) that works on Windows, Linux, Mac OS X, Android, your\r
   5 WebGL enabled browser and iOS.\r
   6 \r
   7 #### Learn [how to contribute][B]\r
   8 #### The [Libgdx Official Site][1] hosts downloads, documentation and contains useful links\r
   9 #### The [community-maintained wiki][4] hosted at Google Code will explain much of Libgdx\r
  10 #### Use the [Badlogic Forum][5] to ask questions about Libgdx\r
  11 #### Follow the [Badlogic Blog][2] for the latest Libgdx news\r
  12 #### Use the [Issue Tracker][3] to post concrete bug reports (with a pull request if possible)\r
  13 #### Chat with us on IRC at irc.freenode.net, #libgdx\r
  14 #### Follow [@badlogicgames][6] on Twitter\r
  15 \r
  16 ## Compiling the Code\r
  17 \r
  18 Be sure to understand the [prerequisites][7] required for Libgdx.\r
  19 \r
  20 See [Running Demos &\r
  21 Tests][8] for\r
  22 instructions on getting the basics working with the source tree.\r
  23 \r
  24 See the [Source Building wiki page][9] for instructions on building\r
  25 native code and building distribution images.\r
  26 \r
  27 You do not have to compile Libgdx, you can [download][A] official\r
  28 releases and nightly build snapshots from [libgdx.badlogicgames.com][A].\r
  29 \r
  30 ## Libgdx Usage Examples\r
  31 \r
  32 There are a number of example games included in the source. Some of them include:\r
  33 \r
  34  - metagun\r
  35  - superjumper\r
  36  - gdx-vertorpinball\r
  37  - rtm\r
  38  - very angry robots\r
  39  - pax-britannica\r
  40 \r
  41 To see how to use libgdx you can either go to the [wiki][4] (which has plenty of good information) or read through\r
  42 these example projects.  The test cases in `tests/gdx-tests/` are another good source of sample code.\r
  43 Once again, if you get stuck just drop in to the friendly [forums][5].\r
  44 \r
  45  [1]: http://libgdx.badlogicgames.com\r
  46  [2]: http://www.badlogicgames.com\r
  47  [3]: http://code.google.com/p/libgdx/issues\r
  48  [4]: http://code.google.com/p/libgdx/wiki/TableOfContents\r
  49  [5]: http://www.badlogicgames.com/forum\r
  50  [6]: http://www.twitter.com/badlogicgames\r
  51  [7]: http://code.google.com/p/libgdx/wiki/Prerequisits\r
  52  [8]: http://code.google.com/p/libgdx/wiki/SourceRunningDemos\r
  53  [9]: http://code.google.com/p/libgdx/wiki/SourceBuilding\r
  54  [A]: http://libgdx.badlogicgames.com/download.html\r
  55  [B]: https://code.google.com/p/libgdx/wiki/Contributing?ts=1363359071&updated=Contributing\r