Permalink
Browse files

README rewrite

  • Loading branch information...
Firew0lf committed Jun 27, 2016
1 parent 5888ee3 commit f118baa37c242a383c4e11ab975eef3ba7585ea6
Showing with 71 additions and 10 deletions.
  1. +71 −10 README.md
@@ -1,25 +1,86 @@
# ctrµLua

Everything is in the Wiki.
![banner](https://www.dropbox.com/s/cqmtoohyx6t7q7c/banner.png?raw=1)

Warning: the 'u' in the repo's name is a 'µ', not a 'u'.

### Users part

#### How to install

* Download ctruLua.zip from the [releases](https://github.com/ctruLua/ctruLua/releases) (for something stable) or the [CI server](http://ci.reuh.tk/ctrulua) (for more features)
* Unzip it on your SD card, in a folder inside your homebrews folder; if you use HBL, extract it in `/3ds/ctrulua/`
* Put some scripts wherever you want, just remember where
* Launch CtrµLua from your homebrew launcher
* Use the shell to run your scripts

### Homebrewers part

#### Builds ![build status](http://ci.reuh.tk/ctrulua.png)

* Most recent working build: [here](http://ci.reuh.tk/ctrulua/builds/latest/artifacts/ctruLua.3dsx) (warning: only tested with Citra, sometimes on real hardware).
* See http://ci.reuh.tk/ctrulua for all the builds.
* Most recent working build: [ctruLua.3dsx](http://ci.reuh.tk/ctrulua/builds/latest/artifacts/ctruLua.3dsx)
* See [http://ci.reuh.tk/ctrulua](http://ci.reuh.tk/ctrulua) for all the builds.

#### Hello world

```Lua
local ctr = require("ctr")
local gfx = require("ctr.gfx")
local hid = require("ctr.hid")
while ctr.run() do
hid.read()
local keys = hid.keys()
if keys.held.start then break end
gfx.start(gfx.TOP)
gfx.text(2, 2, "Hello, world !")
gfx.stop()
gfx.render()
end
```
This script will print "Hello, world !" on the top screen, and will exit if the user presses Start.
This is the "graphical" version; there's also a text-only version, based on the console:
```Lua
local ctr = require("ctr")
local gfx = require("ctr.gfx")
local hid = require("ctr.hid")
gfx.console()
print("Hello, world !")
while ctr.run() do
hid.read()
local keys = hid.keys()
if keys.held.start then break end
gfx.render()
end
gfx.disableConsole()
```

#### Lua API Documentation

* An online version of the documentation can be found [here](http://reuh.tk/ctrulua)
* To build the documentation, run `make build-doc-html` (requires [LDoc](https://github.com/stevedonovan/LDoc)).

### Developers part

#### Build instructions

* Setup your environment as shown here : http://3dbrew.org/wiki/Setting_up_Development_Environment
* Clone this repository and run the command `make build-all` to build all the dependencies.
* If you only made changes to ctrµLua, run `make` to rebuild ctµLua without rebuilding all the dependencies.
* If you only made changes to ctrµLua, run `make` to rebuild ctrµLua without rebuilding all the dependencies.

May not work under Windows.

#### Lua API Documentation

* An online version of the documentation can be found here : http://reuh.tk/ctrulua
* To build the documentation, run `make build-doc` (requires [LDoc](https://github.com/stevedonovan/LDoc)).
### Credits

#### Based on ctrulib by smealum: [https://github.com/smealum/ctrulib](https://github.com/smealum/ctrulib)
* __Smealum__ and everyone who worked on the ctrulib: [https://github.com/smealum/ctrulib](https://github.com/smealum/ctrulib)
* __Xerpi__ for the [sf2dlib](https://github.com/xerpi/sf2dlib), [sftdlib](https://github.com/xerpi/sftdlib) and [sfillib](https://github.com/xerpi/sfillib)
* __All the [Citra](https://citra-emu.org/) developers__
* __Everyone who worked on [DevKitARM](http://devkitpro.org/)__
* __Nothings__ for the [stb](https://github.com/nothings/stb) libs
* Everyone who worked on the other libs we use

0 comments on commit f118baa

Please sign in to comment.