README.md

ThoughtWorks LevelUp project starter kit

Getting started

OSX

1. First up, to get the code, you'll need git installed.

    brew install git
   

2. Now get the code

    git clone [email protected]:twlevelup/lu-lua.git
   

3. You'll also need a version of gcc installed, so you'll need to install XCode with it's command line tools.

4. Install Lua & Luarocks via homebrew (if you're not using homebrew, you probably should be):

    brew install lua
    brew install luarocks
   

5. Install LÖVE to your applications folder.

6. Add an alias in your ~/.bash_profile (or your shell of choice's config) to LÖVE:

    alias love="/Applications/love.app/Contents/MacOS/love"
   

7. Install Busted:

    sudo luarocks install busted
   

Ubuntu (or other debian derived system)

1. Install Lua, Luarocks, LÖVE and git:

    sudo apt-get install git lua5.1 luarocks love
   

If you're not on a recent version of your distro, you probably should install luarocks manually - check out the luarocks site for instructions.

2. Now get the code

    git clone [email protected]:twlevelup/lu-lua.git
   

3. Install Busted:

    sudo luarocks install busted
   

OSX via our script

You may also be able to get set up via our script though it is untested for general use so your mileage may vary. From the project root, you can try your luck with:

./setup/install.sh

Windows

We don't use Windows, so you're on your own. We recommend checking out the Lua website, the Loverocks website, and the LÖVE website for more information. Google is also your friend.

Making it go

Now after cd'ing into the project directory, you should be able to run your tests. Running

 busted

should output something like:

●●●●●●●●●●●●●●●●●●●●●
21 successes / 0 failures / 0 pending : 0.004726 seconds.

You should also be able to run:

love .

and see a happy little nyancat.

Useful resources

Background sprites