Skip to content

Commit

Permalink
Add docs on compiling, and fix test command
Browse files Browse the repository at this point in the history
  • Loading branch information
mschwager committed Feb 16, 2024
1 parent 8979bd3 commit dbac2fd
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Table of contents:
- [Fuzzing pure Ruby code](#fuzzing-pure-ruby-code)
- [Fuzzing Ruby C extensions](#fuzzing-ruby-c-extensions)
- [Developing](#developing)
- [Compiling](#compiling)
- [Testing](#testing)
- [Linting](#linting)
- [Releasing](#releasing)
Expand Down Expand Up @@ -261,14 +262,25 @@ Then, you can shell into the container using the following command:
docker run -it -v $(pwd):/app/ruzzy --entrypoint /bin/bash ruzzy
```

## Compiling

We use [`rake-compiler`](https://github.com/rake-compiler/rake-compiler) to compile Ruzzy's C extensions.

You can compile the C extensions within the container with the following command:

```bash
rake compile
```

## Testing

We use `rake` unit tests to test Ruby code.

You can run the tests within the container with the following command:

```bash
rake test
LD_PRELOAD=$(ruby -e 'require "ruzzy"; print Ruzzy::ASAN_PATH') \
rake test
```

## Linting
Expand Down

0 comments on commit dbac2fd

Please sign in to comment.