Merge pull request #30 from nicholas-leonard/rtd

readthedocs

1 files changed, 18 insertions, 18 deletions

diff --git a/README.md b/README.md
index 09938de..fa7cbff 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,4 @@
-TREPL: A REPL for Torch
-=======================
+# TREPL: A REPL for Torch
 
 ```
   ______             __   |  Torch7
@@ -11,7 +10,8 @@ TREPL: A REPL for Torch
 th>
 ```
 
-A pure Lua REPL for LuaJIT, with heavy support for Torch types. 
+A pure Lua [REPL](https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop) 
+for LuaJIT, with heavy support for Torch types. 
 
 Uses Readline for tab completion.
 
@@ -20,21 +20,21 @@ comes packed with all these features:
 
 Features:
 
-* Tab-completion on nested namespaces
-* Tab-completion on disk files (when opening a string)
-* History
-* Pretty print (table introspection and coloring)
-* Auto-print after eval (can be stopped with ;)
-* Each command is profiled, timing is reported
-* No need for '=' to print
-* Easy help with: `? funcname`
-* Self help: `?`
-* Shell commands with: $ cmd (example: `$ ls`)
-* Print all user globals with `who()`
-* Import a package's symbols globally with `import(package)`
-* Require is overloaded to provide relative search paths: `require('./mylocallib/')`
-* Optional strict global namespace monitoring
-* Optional async repl (based on [async](https://github.com/clementfarabet/async))
+  * Tab-completion on nested namespaces
+  * Tab-completion on disk files (when opening a string)
+  * History
+  * Pretty print (table introspection and coloring)
+  * Auto-print after eval (can be stopped with ;)
+  * Each command is profiled, timing is reported
+  * No need for '=' to print
+  * Easy help with: `? funcname`
+  * Self help: `?`
+  * Shell commands with: $ cmd (example: `$ ls`)
+  * Print all user globals with `who()`
+  * Import a package's symbols globally with `import(package)`
+  * Require is overloaded to provide relative search paths: `require('./mylocallib/')`
+  * Optional strict global namespace monitoring
+  * Optional async repl (based on [async](https://github.com/clementfarabet/async))
 
 Install
 -------