OSDN Git Service

Sync with change to core
[mikumikustudio/libgdx-mikumikustudio.git] / README.md
index 9958785..c38bc56 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,55 +1,45 @@
-# Libgdx\r
+![logo](http://libgdx.badlogicgames.com/img/logo.png)\r
+\r
+*We just migrated our Wiki to Github, so it's a little bit rough, we'll fix things up in the next days*\r
 \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 iOS.\r
 \r
-#### Learn [how to contribute][B]\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
-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
-See the [Source Building wiki page][9] for instructions on building\r
-native code and building distribution images.\r
-\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
-## Libgdx Usage Examples\r
-\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.  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
- [3]: http://code.google.com/p/libgdx/issues\r
- [4]: http://code.google.com/p/libgdx/wiki/TableOfContents\r
- [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\r
- [B]: https://code.google.com/p/libgdx/wiki/Contributing?ts=1363359071&updated=Contributing\r
+#### Getting Started\r
+Head over to http://libgdx.badlogicgames.com/documentation.html to find the latest getting started guide,\r
+download links and so on. You can find more information on libgdx on our official site \r
+at http://libgdx.badlogicgames.com/\r
+\r
+#### Documentation\r
+The [Wiki](https://github.com/libgdx/libgdx/wiki) contains all the information you'll need to write a \r
+libgdx game. You can contribute to the Wiki directly here on Github!\r
+\r
+We also provide [Javadocs](http://libgdx.badlogicgames.com/nightlies/docs/api/) online. The Javadocs are\r
+also bundled as source Jars with every libgdx distribution for consumption in your favorite IDE.\r
+\r
+#### News & Community\r
+You can follow the latest news about libgdx on the [blog](http://www.badlogicgames.com). Follow\r
+[@badlogicgames](https://twitter.com/badlogicgames) for real-time updates.\r
+\r
+You can get help on our [forum](http://badlogicgames.com/forum/) and talk to other libgdx \r
+users on our IRC channel #libgdx at irc.freenode.net.\r
+\r
+#### Reporting Issues\r
+Use the [issue tracker](https://github.com/libgdx/libgdx/issues?page=1&state=open) here on Github to report issues. Make sure you read the \r
+[Getting Help](https://github.com/libgdx/libgdx/wiki/Getting-help) article that walks you through\r
+the process or properly reporting an issue.\r
+\r
+#### Contributing & Working from Source\r
+Libgdx has a strong developer community constantly improving the code base. We love to\r
+get any and all help we can. The [Contributing](https://github.com/libgdx/libgdx/wiki/Contributing) \r
+article describes the process of helping libgdx to become even better.\r
+\r
+To contribute, you need to work with libgdx' sources directly, something normal users do not\r
+have to go through. The [Working with the Source](https://github.com/libgdx/libgdx/wiki/Working-from-source)\r
+article will give you directions.\r
+\r
+#### License\r
+Libgdx is licensed under the [Apache 2 License](http://www.apache.org/licenses/LICENSE-2.0.html), meaning you\r
+can use it free of charge, without strings attached in commercial and non-commercial projects. We love to\r
+get (non-mandatory) credit in case you release a game or app using libgdx!\r