Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/keplerproject/luafilesystem.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIgnacio Burgueño <ignaciob@inconcertcc.com>2016-01-21 19:59:29 +0300
committerIgnacio Burgueño <ignaciob@inconcertcc.com>2016-01-21 19:59:29 +0300
commit9e7f97ea4c7ec2a66b9ea1ef6c7dd068822b414d (patch)
tree79cf82fd167c3f6d5963c662d58583a75b37bd17 /README.md
parent488304b5a5cff6ae63d5f0aa3950b61fd2f512f3 (diff)
Change readme to markdown format
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..40f21ab
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# LuaFileSystem - File System Library for Lua
+Copyright 2003-2015 Kepler Project
+
+http://keplerproject.github.io/luafilesystem
+
+# Description
+
+LuaFileSystem is a Lua library developed to complement the set of functions
+related to file systems offered by the standard Lua distribution.
+
+LuaFileSystem offers a portable way to access the underlying directory structure and file attributes.
+LuaFileSystem is free software and uses the same license as Lua 5.1
+
+# LuaRocks Installation
+
+```
+luarocks install luafilesystem
+```
+
+# Documentation
+
+Please check the documentation at doc/us/ for more information.