Added a readme

This commit is contained in:
Eric-Paul Ickhorn 2023-11-26 21:13:08 +01:00
parent 6e349ea298
commit a83770c31d
1 changed files with 39 additions and 0 deletions

39
README.md Normal file
View File

@ -0,0 +1,39 @@
# 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`, `1d`, ...)
- `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
```