Update README.md
This commit is contained in:
24
README.md
24
README.md
@@ -6,11 +6,29 @@ This is a toy project not meant to be taken very seriously.
|
||||
|
||||
## Requirements for Use
|
||||
|
||||
[GCC](https://en.wikipedia.org/wiki/GNU_Compiler_Collection) is required as it is currently the back-end tool used to compile the C code.
|
||||
[GCC](https://en.wikipedia.org/wiki/GNU_Compiler_Collection) is recommended as the compiler installed for `Pallet` projects.
|
||||
|
||||
This tool calls `gcc` internally, so without it, it would fail.
|
||||
You can define a different `gcc` compatible compiler instead per-project by editing `Pallet.toml`:
|
||||
|
||||
At some point I would like to update `Pallet.toml` to instead allow more configuring of how the build should be performed.
|
||||
```toml
|
||||
name = "my-app"
|
||||
default_build = "debug"
|
||||
compiler = "clang"
|
||||
|
||||
[[build]]
|
||||
name = "debug"
|
||||
args = [
|
||||
"-g",
|
||||
"-O0",
|
||||
]
|
||||
|
||||
[[build]]
|
||||
name = "release"
|
||||
args = [
|
||||
"-DNDEBUG",
|
||||
"-O3",
|
||||
]
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
|
||||
Reference in New Issue
Block a user