mirror of
https://github.com/dexoron/dcr.git
synced 2026-10-21 14:38:30 +00:00
New docs
This commit is contained in:
@@ -1,2 +1,45 @@
|
||||
# dcr.toml overview
|
||||
|
||||
`dcr.toml` is the main project file used by DCR.
|
||||
|
||||
## Minimal generated template
|
||||
|
||||
```toml
|
||||
[package]
|
||||
name = "hello"
|
||||
version = "0.1.0"
|
||||
|
||||
[build]
|
||||
language = "c"
|
||||
standard = "c11"
|
||||
compiler = "clang"
|
||||
kind = "bin"
|
||||
|
||||
[dependencies]
|
||||
```
|
||||
|
||||
`dcr new` and `dcr init` generate this structure automatically.
|
||||
|
||||
## Required sections
|
||||
|
||||
- `[package]`
|
||||
- `[build]`
|
||||
- `[dependencies]`
|
||||
|
||||
## Required keys
|
||||
|
||||
- `package.name`
|
||||
- `package.version`
|
||||
- `build.language`
|
||||
- `build.standard`
|
||||
- `build.compiler`
|
||||
- `build.kind`
|
||||
|
||||
`build.kind` must be either `bin` or `staticlib`.
|
||||
|
||||
## Optional keys
|
||||
|
||||
- `build.target`
|
||||
- `build.cflags`
|
||||
- `build.ldflags`
|
||||
- dependency fields (`include`, `lib`, `libs`, `system`)
|
||||
|
||||
Reference in New Issue
Block a user