Skip to content

Commit c59c2a5

Browse files
authored
Merge pull request #649 from pallene-lang/update-readme
Update README to include Pallene Tracer build instructions
2 parents 13fb1a3 + bbfa81e commit c59c2a5

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,21 @@ It needs to say `Lua 5.x.x with core API`.
3434
If it doesn't have the "with core API",
3535
that means you're using the default Lua instead of the special Lua.
3636

37+
### Install Pallene Tracer
38+
39+
For debugging purposes, Pallene uses a tool called Pallene Tracer, which is required to trace function calls throughout
40+
Pallene and Lua environments. You must clone and compile Pallene Tracer from its repository
41+
[pallene-tracer](https://github.com/pallene-lang/pallene-tracer). You need to use a specific version, `0.5.0a`.
42+
43+
```sh
44+
git clone https://www.github.com/pallene-lang/pallene-tracer --depth 1 --branch 0.5.0a
45+
cd pallene-tracer
46+
make LUA_PREFIX=/usr/local
47+
sudo make install
48+
```
49+
50+
Here, `LUA_PREFIX=/usr/local` is used to point to the patched Lua for Pallene.
51+
3752
### Install Luarocks
3853

3954
The next step is to get the Luarocks package manager.
@@ -66,10 +81,6 @@ Remember that in order for the local rocks tree to work, you must to set the PAT
6681
eval "$(luarocks path)"
6782
```
6883

69-
### Install the Pallene Tracer
70-
71-
Refer to the README at https://github.com/pallene-lang/pallene-tracer
72-
7384
### Install Pallene
7485

7586
Finally, we can use Luarocks to build and install the Pallene compiler.

0 commit comments

Comments
 (0)