Skip to content

Commit c87da71

Browse files
committed
Add instructions to readme for running tests and generating docs
1 parent 36867e6 commit c87da71

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

README.md

+14-8
Original file line numberDiff line numberDiff line change
@@ -59,14 +59,20 @@ See docs/index.html for more details.
5959

6060
Prerequisites
6161
=============
62+
To run the tests:
6263
```
63-
#for unit tests
64-
$luarocks install lunit
65-
$luarocks install luaposix
66-
$luarocks install luasocket
67-
$luarocks install lua-cjson
68-
69-
#for generating docs
70-
$luarocks install ldoc
64+
luarocks install lunit
65+
luarocks install lua-cjson
66+
luarocks install luaposix
67+
luarocks install luasocket
68+
luarocks install luasec
69+
70+
lunit tests/*
71+
```
72+
73+
To generate the docs:
7174
```
75+
luarocks install ldoc
7276
77+
ldoc raven.lua -d docs -p raven-lua
78+
```

0 commit comments

Comments
 (0)