diff options
| author | Ignacio Burgueño <ignaciob@inconcertcc.com> | 2016-01-21 13:59:29 -0300 |
|---|---|---|
| committer | Ignacio Burgueño <ignaciob@inconcertcc.com> | 2016-01-21 13:59:29 -0300 |
| commit | 9e7f97ea4c7ec2a66b9ea1ef6c7dd068822b414d (patch) | |
| tree | 79cf82fd167c3f6d5963c662d58583a75b37bd17 /README.md | |
| parent | 488304b5a5cff6ae63d5f0aa3950b61fd2f512f3 (diff) | |
| download | luafilesystem-9e7f97ea4c7ec2a66b9ea1ef6c7dd068822b414d.tar.gz luafilesystem-9e7f97ea4c7ec2a66b9ea1ef6c7dd068822b414d.tar.bz2 luafilesystem-9e7f97ea4c7ec2a66b9ea1ef6c7dd068822b414d.zip | |
Change readme to markdown format
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 22 |
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 @@ | |||
| 1 | # LuaFileSystem - File System Library for Lua | ||
| 2 | Copyright 2003-2015 Kepler Project | ||
| 3 | |||
| 4 | http://keplerproject.github.io/luafilesystem | ||
| 5 | |||
| 6 | # Description | ||
| 7 | |||
| 8 | LuaFileSystem is a Lua library developed to complement the set of functions | ||
| 9 | related to file systems offered by the standard Lua distribution. | ||
| 10 | |||
| 11 | LuaFileSystem offers a portable way to access the underlying directory structure and file attributes. | ||
| 12 | LuaFileSystem is free software and uses the same license as Lua 5.1 | ||
| 13 | |||
| 14 | # LuaRocks Installation | ||
| 15 | |||
| 16 | ``` | ||
| 17 | luarocks install luafilesystem | ||
| 18 | ``` | ||
| 19 | |||
| 20 | # Documentation | ||
| 21 | |||
| 22 | Please check the documentation at doc/us/ for more information. | ||