Merge pull request #648 from bjornbm/docs

README and CONTRIBUTING updates

Author: hugomg

CONTRIBUTING.md

@@ -21,18 +21,20 @@ You can do so using LuaRocks; for full instructions see our [`.luacheckrc`](.lua
 
 ### Running the test suite
 
-We use [Busted](http://olivinelabs.com/busted/) to run our test suite.
-It can be installed using LuaRocks:
+We use [Busted](http://olivinelabs.com/busted/) to run our test suite
+and [Luacheck](https://github.com/lunarmodules/luacheck) for linting.
+They can both be installed using LuaRocks:
 
 ```sh
-$ luarocks install busted
+luarocks install busted
+luarocks install luacheck
 ```
 
 To run the test suite, run the `./run-tests` script in this project's root directory.
 
 ```sh
-$ ./run-tests                       # Run all tests
-$ ./run-tests spec/parser_spec.lua  # Run just one of the test suite files
+./run-tests                       # Run all tests
+./run-tests spec/parser_spec.lua  # Run just one of the test suite files
 ```
 
 **Tip:** We recommend having [GNU parallel](https://www.gnu.org/software/parallel/) installed.
@@ -57,7 +59,7 @@ environment variable to "-DHARDMEMTESTS" for the `run-tests` script. For
 example:
 
 ```sh
-$ EXTRACFLAGS="-DHARDMEMTESTS" ./run-tests
+EXTRACFLAGS="-DHARDMEMTESTS" ./run-tests
 ```
 
 ### Running the benchmarks suite

README.md

@@ -24,6 +24,7 @@ git clone https://www.github.com/pallene-lang/lua-internals/
 cd lua-internals
 make guess -j4
 sudo make install
+cd -
 ```
 
 If you are on Linux and would like the up arrow to work in the Lua REPL,
@@ -42,12 +43,13 @@ To build Luarocks, unpack the sources and run `configure`, `make`, and `make ins
 In the configure step, use `--with-lua` to point to our special Lua.
 
 ```sh
-wget https://luarocks.org/releases/luarocks-3.9.1.tar.gz
-tar xf luarocks-3.9.1.tar.gz
-cd luarocks-3.9.1
+wget https://luarocks.org/releases/luarocks-3.11.1.tar.gz
+tar xf luarocks-3.11.1.tar.gz
+cd luarocks-3.11.1
 ./configure --with-lua=/usr/local
 make
 sudo make install
+cd -
 ```
 
 By default, Luarocks installs packages into /usr/local, which requires sudo.
@@ -64,6 +66,10 @@ Remember that in order for the local rocks tree to work, you must to set the PAT
 eval "$(luarocks path)"
 ```
 
+### Install the Pallene Tracer
+
+Refer to the README at https://github.com/pallene-lang/pallene-tracer
+
 ### Install Pallene
 
 Finally, we can use Luarocks to build and install the Pallene compiler.
@@ -73,6 +79,20 @@ This will also download and install the necessary Lua libraries.
 luarocks make pallene-dev-1.rockspec
 ```
 
+If you used non-standard install locations in the previous steps, you may have to specify them.
+
+```sh
+export CPATH=/usr/local/include
+luarocks make pallene-dev-1.rockspec PTRACER_DIR=/usr/local
+```
+
+To avoid specifying PTRACER_DIR every time you run Luarocks, you can add it to the config.
+
+```
+luarocks config PTRACER_DIR /usr/local
+luarocks make pallene-dev-1.rockspec
+```
+
 ## Using Pallene
 
 To compile a `foo.pln` file to a `foo.so` module, call `pallenec` as follows.