From ade5bb6ad732542bc7f98f98bf95927647cdf531 Mon Sep 17 00:00:00 2001
From: Clement Farabet <clement.farabet@gmail.com>
Date: Wed, 10 Jul 2013 10:08:15 -0400
Subject: README

---
 README.md  | 68 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 README.txt | 63 ---------------------------------------------------------
 2 files changed, 68 insertions(+), 63 deletions(-)
 create mode 100644 README.md
 delete mode 100644 README.txt

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..082dce3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,68 @@
+# A set of useful extensions to Lua
+
+## Dependencies:
+Torch7 (www.torch.ch)
+
+## Install:
+```
+$ torch-rocks install xlua
+```
+
+## Use
+```
+$ torch -lxlua
+xLua > a = 5
+xLua > b = 'test'
+xLua > xlua.who()
+
+Global Libs:
+{[1] = string,
+ [2] = package,
+ [3] = os,
+ [4] = io,
+ [5] = xlua,
+ [6] = sys,
+ [7] = math,
+ [8] = debug,
+ [9] = table,
+ [10] = coroutine}
+
+Global Vars:
+{[a] = 5,
+ [b] = test}
+
+xLua > xlua.clearall()   -- also calls the garbage collector !
+xLua > xlua.who()
+
+Global Libs:
+{[1] = string,
+ [2] = package,
+ [3] = os,
+ [4] = io,
+ [5] = xlua,
+ [6] = sys,
+ [7] = math,
+ [8] = debug,
+ [9] = table,
+ [10] = coroutine}
+
+Global Vars:
+{}
+
+xLua > print(xlua)
+{[clear] = function: 0x10020cd10,
+ [clearall] = function: 0x10020ca70,
+ [_PACKAGE] = ,
+ [progress] = function: 0x10020cda0,
+ [print] = function: 0x10020c9d0,
+ [_NAME] = xlua,
+ [who] = function: 0x10020cd50,
+ [_M] = table: 0x10020c990,
+ [lua_print] = function: 0x100201900}
+
+xLua > test = {a = 14, b = "test"}
+xLua > =test
+{[a] = 14,
+ [b] = test}
+xLua > 
+```
diff --git a/README.txt b/README.txt
deleted file mode 100644
index c1c419e..0000000
--- a/README.txt
+++ /dev/null
@@ -1,63 +0,0 @@
-DEPENDENCIES:
-Torch7 (www.torch.ch)
-
-INSTALL:
-$ torch-rocks install xlua
-
-USE:
-$ torch -lxlua
-xLua > a = 5
-xLua > b = 'test'
-xLua > xlua.who()
-
-Global Libs:
-{[1] = string,
- [2] = package,
- [3] = os,
- [4] = io,
- [5] = xlua,
- [6] = sys,
- [7] = math,
- [8] = debug,
- [9] = table,
- [10] = coroutine}
-
-Global Vars:
-{[a] = 5,
- [b] = test}
-
-xLua > xlua.clearall()   -- also calls the garbage collector !
-xLua > xlua.who()
-
-Global Libs:
-{[1] = string,
- [2] = package,
- [3] = os,
- [4] = io,
- [5] = xlua,
- [6] = sys,
- [7] = math,
- [8] = debug,
- [9] = table,
- [10] = coroutine}
-
-Global Vars:
-{}
-
-xLua > print(xlua)
-{[clear] = function: 0x10020cd10,
- [clearall] = function: 0x10020ca70,
- [_PACKAGE] = ,
- [progress] = function: 0x10020cda0,
- [print] = function: 0x10020c9d0,
- [_NAME] = xlua,
- [who] = function: 0x10020cd50,
- [_M] = table: 0x10020c990,
- [lua_print] = function: 0x100201900}
-
-xLua > test = {a = 14, b = "test"}
-xLua > =test
-{[a] = 14,
- [b] = test}
-xLua > 
-
-- 
cgit v1.2.3