52 lines
1.1 KiB
Groff
52 lines
1.1 KiB
Groff
.TH "TBUILD MANIFEST" 5 "" "" "TBuild Manual"
|
|
.SH NAME
|
|
tos_project.toml \- TBuild project manifest file
|
|
.SH DESCRIPTION
|
|
The file
|
|
.I tos_project.toml
|
|
contains configuration infromation about a tbuild project. It is based off of
|
|
the TOML file format, which is similar to that of an INI file.
|
|
The following sections are recognized:
|
|
.TP
|
|
.I General
|
|
This section contains general information about the project.
|
|
.TP
|
|
.I Dependencies
|
|
This section contains different dependencies of the project.
|
|
.SH GENERAL
|
|
The General section contains a few variables which can be changed:
|
|
.TP
|
|
.I Name [string]
|
|
The name of the project.
|
|
.TP
|
|
.I Author [string]
|
|
Who made the project.
|
|
.TP
|
|
.I Version [string]
|
|
The version of the project.
|
|
.SH DEPENDENCIES
|
|
The General section is a bit more complicated. It is made of key-value pairs,
|
|
the key being the name of the dependency and the value being the git repository
|
|
to it.
|
|
.SH EXAMPLE
|
|
.PP
|
|
This is how a simple configuration file may look like, using Alec's AC97 driver
|
|
library:
|
|
.RS 4
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
[General]
|
|
Name="MyProject"
|
|
Author="Jeff"
|
|
Version="2.2"
|
|
|
|
[Dependencies]
|
|
ac97 = "https://git.checksum.fail/slendi/ac97.git"
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|