# h-raylib contributor guide

Anybody willing to contribute to the project is welcome to do so. Please use the GitHub issue tracker to report any bugs you find.

You can run the examples by using `cabal run [example-name]` in the project directory.

You can run an example with profiling by using `cabal run [example-name] --ghc-options="-fprof-auto -rtsopts -threaded" --enable-library-profiling --enable-profiling -- +RTS -N -P`. This will generate a file `example-name.prof` with the profiling info.

You can use `run-all-examples.sh` to run all of the examples in one go.

You can use `./devtools.js [options]` (on Linux) or `node devtools.js [options]` anywhere else for general development utilities. Use the `--help` flag for details.

[DOCUMENTATION.md](https://github.com/Anut-py/h-raylib/blob/master/DOCUMENTATION.md) has information that is specific to h-raylib.

## h-raylib roadmap

This is a list of features that may be added to this project. Contributors are welcome to help implement these.

### Pending

Items which have not yet been worked on. Feel free to work on one of these.

- Bind `rgestures`

### In progress

- Add web build support \[[#4](https://github.com/Anut-py/h-raylib/issues/4)\]