notid/play-clj
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Create initial README

Browse Source
This commit is contained in:
oakes
2013-12-31 23:03:03 -05:00
parent 9c7e9c542a
commit c43f341896
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -1,2 +1,8 @@
play-clj
========
## Introduction
A Clojure library that provides a wrapper for [LibGDX](http://libgdx.badlogicgames.com/), allowing you to write Clojure games that run on desktops (Windows/OSX/Linux), Android, and iOS. It is in a very early stage of development, so for now there is no documentation beyond the source code itself.
## Installation
The recommended way to start using play-clj is to create a Clojure game project with [Nightcode](https://nightcode.info/). It will automatically generate three separate Leiningen projects for desktop, Android, and iOS, all pointing to the same source code and resources directories. You can build the projects with Nightcode itself or with Leiningen on the command line (if you choose the latter, you will need to set up [lein-droid](https://github.com/clojure-android/lein-droid) and [lein-fruit](https://github.com/oakes/lein-fruit) to build the Android and iOS projects respectively).