Document LFS installation

Mon, 06 Jul 2020 12:35:04 -0500

author
Tuomo Valkonen <tuomov@iki.fi>
date
Mon, 06 Jul 2020 12:35:04 -0500
changeset 24
4013d2901832
parent 23
0ea4b0786b43
child 25
11ae9103f59d

Document LFS installation

README.md file | annotate | diff | comparison | revisions
--- a/README.md	Mon Jul 06 12:19:21 2020 -0500
+++ b/README.md	Mon Jul 06 12:35:04 2020 -0500
@@ -20,7 +20,11 @@
 
 ## Installation
 
-You need to install [Lua 5.3][Lua].
+You need to install [Lua 5.3][Lua] and [LuaFileSystem][], e.g. using
+[LuaRocks][]):
+```sh
+$ luarocks install luafilesystem
+```
 To use [markdown-it][], you need to install [NodeJS][] and then execute `npm install` to install in the top directory of this project.
 
 ## License
@@ -34,3 +38,5 @@
 [Pandoc]: https://pandoc.org/
 [Lua]: http://www.lua.org/
 [NodeJS]: https://nodejs.org/en/
+[LuaRocks]: https://luarocks.org/
+[LuaFileSystem]: http://keplerproject.github.io/luafilesystem/

mercurial