diff --git a/README.md b/README.md index 66ca656..c2372ac 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Pallet -Pallet is a project manager and build system for C inspired by Cargo for Rust. +Pallet is a project manager and build system for C inspired by Rust's Cargo. This is a toy project not meant to be taken very seriously. @@ -10,6 +10,7 @@ This is a toy project not meant to be taken very seriously. - `pallet init`: initializes a new project in the current directory - `pallet run`: runs the local project - `pallet build`: builds the local project +- `pallet clean`: cleans the local project's build artifacts ## Configuring @@ -17,4 +18,31 @@ You can configure options by editing `Pallet.toml` ### Options -TBD +- `name`: the name of the output executable +- `default_build`: the name of the default build profile to use + +Additionally, one can define one or more build profiles with the following parameters: + +- `name`: the name of the build profile +- `args`: the args to supply to gcc when using this profile + +For example: + +```toml +name = "my-app" +default_build = "debug" + +[[build]] +name = "debug" +args = [ + "-g", + "-O0", +] + +[[build]] +name = "release" +args = [ + "-DNDEBUG", + "-O3", +] +```