README.md
1 ![logo](http://libgdx.badlogicgames.com/img/logo.png)
2
3 [![Build Status](http://144.76.220.132:8080/buildStatus/icon?job=libgdx&.png)](http://144.76.220.132:8080/job/libgdx/)
4
5 libGDX is a cross-platform Java game development framework based on
6 OpenGL (ES) that works on Windows, Linux, Mac OS X, Android, your
7 WebGL enabled browser and iOS.
8
9 ### Getting Started
10 * [Setup your development environment (Eclipse, Intellij IDEA, NetBeans)](https://github.com/libgdx/libgdx/wiki/Setting-up-your-Development-Environment-%28Eclipse%2C-Intellij-IDEA%2C-NetBeans%29)
11 * [Create a libGDX project](https://github.com/libgdx/libgdx/wiki/Project-Setup-Gradle)
12 * Import, Run, Debug and Package your project
13 * [Eclipse](https://github.com/libgdx/libgdx/wiki/Gradle-and-Eclipse)
14 * [Intellij IDEA](https://github.com/libgdx/libgdx/wiki/Gradle-and-Intellij-IDEA)
15 * [NetBeans](https://github.com/libgdx/libgdx/wiki/Gradle-and-NetBeans)
16 * [Commandline](https://github.com/libgdx/libgdx/wiki/Gradle-on-the-Commandline)
17 * [Read the Wiki](https://github.com/libgdx/libgdx/wiki)
18
19 ### Downloads
20 As we switched to Gradle, there's no need to download libGDX itself anymore. For those of you who still prefer the old way of doing things, you can get libGDX from the [official download site](http://libgdx.badlogicgames.com/download.html).
21
22 ### Documentation
23 The [Wiki](https://github.com/libgdx/libgdx/wiki) contains all the information you'll need to write a
24 libGDX game. You can contribute to the Wiki directly here on GitHub!
25
26 We also provide [Javadocs](http://libgdx.badlogicgames.com/nightlies/docs/api/) online. The Javadocs are
27 also bundled as source Jars with every libGDX distribution for consumption in your favorite IDE.
28
29 ### News & Community
30 You can follow the latest news about libGDX on the [blog](http://www.badlogicgames.com). Follow
31 [@badlogicgames](https://twitter.com/badlogicgames) for real-time updates.
32
33 You can get help on our [forum](http://badlogicgames.com/forum/) and talk to other libGDX
34 users on our IRC channel #libgdx at irc.freenode.net.
35
36 ### Reporting Issues
37 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
38 [Getting Help](https://github.com/libgdx/libgdx/wiki/Getting-help) article that walks you through
39 the process or properly reporting an issue.
40
41 ### Contributing & Working from Source
42 libGDX has a strong developer community constantly improving the code base. We love to
43 get any and all help we can. The [Contributing](https://github.com/libgdx/libgdx/wiki/Contributing)
44 article describes the process of helping libGDX to become even better.
45
46 To contribute, you need to work with libGDX' sources directly, something normal users do not
47 have to go through. The [Working with the Source](https://github.com/libgdx/libgdx/wiki/Running-demos-%26-tests)
48 article will give you directions.
49
50 You can also contribute financially to our infrastructure (build server, web server, test devices) via our [Patreon](http://patreon.com/libgdx)!
51
52 ### License
53 libGDX is licensed under the [Apache 2 License](http://www.apache.org/licenses/LICENSE-2.0.html), meaning you
54 can use it free of charge, without strings attached in commercial and non-commercial projects. We love to
55 get (non-mandatory) credit in case you release a game or app using libgdx!
56
57 ### Supported By
58 libGDX is supported by helpful 3rd parties via code contributions, free licenses, test devices and so forth. Make our supporters happy and visit their sites!
59
60 <table>
61 <tr>
62 <td style="text-align: center;"><a href="http://bit.ly/robovmgdx"><img style="margin-right:20px" src="http://libgdx.badlogicgames.com/img/robovm.png" alt="RoboVM" /></a></td>
63 <td style="text-align: center;"><a href="http://bit.ly/spinegdx"><img src="http://libgdx.badlogicgames.com/img/spine.png"></a></td>
64 </tr>
65
66 <tr>
67 <td style="text-align: center;"><a href="http://bit.ly/saikoagdx"><img style="margin-right:20px" src="http://libgdx.badlogicgames.com/img/saikoa.png" alt="Saikoa" /></a></td>
68 <td style="text-align: center;"><a href="http://bit.ly/intelgdx"><img src="http://libgdx.badlogicgames.com/img/intel.png" alt="intel Software Partner" /></a></td>
69 </tr>
70
71 <tr>
72 <td style="text-align: center;"><a href="http://bit.ly/jetblog"><img src="http://libgdx.badlogicgames.com/img/excelsior.png" alt="Excelsior JET"></a></td>
73 <td style="text-align: center;"><a href="http://bit.ly/nextpeergdx"><img src="http://libgdx.badlogicgames.com/img/nextpeer.png"></a></td>
74 </tr>
75 </table>
76
77 Intel and the Intel logo are trademarks of Intel Corporation in the U.S. and/or other countries.
78