Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Spice up the README a little bit #26

Merged
merged 5 commits into from
Aug 22, 2024
Merged

Spice up the README a little bit #26

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9df3d57
Spice up the README a little bit
singul4ri7y Aug 19, 2024
e410e89
Minor typo fix. Oops!
singul4ri7y Aug 19, 2024
49bdaeb
Update README
singul4ri7y Aug 22, 2024
7b5836e
Add strict Lua version
singul4ri7y Aug 22, 2024
d91dad6
Nitfix on version emphasis
singul4ri7y Aug 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 30 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,30 @@
# pallene-tracer
Pallene Tracer is a mechanism and protocol for Lua C modules to have proper tracebacks
<h1 align="center">The Pallene Tracer</h1>

Pallene Tracer is a project providing protocols and underlying mechanism aiming to enable Lua C modules to have proper function call-traceback, without touching a single code in Lua internals!

hugomg marked this conversation as resolved.
Show resolved Hide resolved
## Installing Pallene Tracer

### Prerequisites

You need to have Lua installed in your system in any prefix.

### Procedure

To install Pallene Tracer in `/usr/local` prefix, against system Lua with `/usr` prefix:
```
hugomg marked this conversation as resolved.
Show resolved Hide resolved
sudo make install
```

To install Pallene Tracer against local Lua with `/usr/local` prefix (or any prefix):
```
sudo make install LUA_PREFIX=/usr/local
```

Pallene Tracer sometime fails to build if Lua is built with address sanitizer (ASan) enabled. To get around the issue use:
```
sudo make install LDFLAGS=-lasan
```

### How to use Pallene Tracer

Notes on how Pallene Tracer is designed and how to use it can be found in the [docs](https://github.com/pallene-lang/pallene-tracer/blob/main/docs/MANUAL.md). Also feel free to look at the `examples` directory for further intuition.
Loading