readme.md
1LÖVE is an *awesome* framework you can use to make 2D games in Lua. It's free, open-source, and works on Windows, Mac OS X and Linux.
2
3Documentation
4-------------
5
6We use our [wiki][wiki] for documentation.
7If you need further help, feel free to ask on our [forums][forums], and last but not least there's the irc channel [#love on Freenode][irc].
8
9Compilation
10-----------
11
12###Windows
13Use the project files for Visual C++ 2008 or 2010 (2010 preferred) located in the platform dir.
14
15###*nix
16Run platform/unix/automagic, then run ./configure and make.
17
18###OSX
19Use the XCode project in platform/macosx.
20
21For both Windows and OSX there are dependencies available [here][dependencies].
22
23Repository information
24----------------------
25
26We use the 'default' branch for development, and therefore it should not be considered stable.
27Also used is the 'minor' branch, which is used for features in the next minor version and it is
28not our development target (which would be the next revision). (Version numbers formatted major.minor.revision.)
29
30We tag all our releases (since we started using mercurial), and have binary downloads available for them.
31
32Builds
33------
34
35Releases are found in the 'downloads' section on bitbucket, are linked on [the site][site],
36and there's a ppa for ubuntu, [ppa:bartbes/love-stable][stableppa].
37
38There are also unstable/nightly builds:
39
40- For windows they are located [here][winbuilds].
41- For ubuntu linux they are in [ppa:bartbes/love-unstable][unstableppa]
42- For arch linux there's [love-hg][aur] in the AUR.
43- For other linuxes and OSX there are currently no official builds.
44
45Dependencies
46------------
47
48- SDL
49- OpenGL
50- OpenAL
51- Lua / LuaJIT / LLVM-lua
52- DevIL with MNG and TIFF
53- FreeType
54- PhysicsFS
55- ModPlug
56- mpg123
57- Vorbisfile
58
59[site]: http://love2d.org
60[wiki]: http://love2d.org/wiki
61[forums]: http://love2d.org/forums
62[irc]: irc://irc.freenode.net/love
63[dependencies]: http://love2d.org/sdk
64[winbuilds]: http://love2d.org/builds
65[stableppa]: https://launchpad.net/~bartbes/+archive/love-stable
66[unstableppa]: https://launchpad.net/~bartbes/+archive/love-unstable
67[aur]: http://aur.archlinux.org/packages.php?ID=35279
68