Parcel/README.md

# Parcel

Parcel is a (currently experimental) parser generator.

## Building

Parcel has very few dependencies. Below, there's a list of those
dependencies that Parcel has:

- `gcc` (no other compiler is supported)
- binutils (`ar`, `ld`, ...)
- `bash`
- *The Usual* (a *libc*, the *system headers*, ...)

To build Parcel, navigate to the repository's root directory
and type the command below. It will perform all compiler calls
and create the code archive at *.build/libparcel.a* .

```bash
./build.bash release
```

### Debug Builds

For development, there are two other important commands, the first of
which being for compiling the library with debug information.

```bash
./build.bash debug
```

The second command builds the manual checks which are located in
the sub-folder `checks/`.

```bash
./build.bash checks
```