Commit 3f635124 authored by Drew's avatar Drew

More documentation

parent 90693a34
......@@ -22,25 +22,22 @@ atbuild [task]
# Configuration
```bash
$ atbuild
$ atbuild build
$ atbuild build-tests
$ atbuild run-tests
```
The configuration file defines *tasks*, which are entrypoints on the CLI. `build`, `build-tests`, and `run-tests` are *tasks*.
The configuration file defines *tasks*, which are entrypoints on the CLI. If no task is specified, we run a task called `default`.
This runs a task called `default`:
```bash
$ atbuild
```
Configurations could look like this:
Configurations [are unsupported](https://github.com/AnarchyTools/atbuild/issues/2) but could look like this:
```bash
$ atbuild run-tests --platform linux
```
A complete atbuild.yaml example is below.
```yaml
package:
name: "sample"
......
......@@ -4,7 +4,7 @@ The `atllbuild` tool uses the `swift-llbuild` project to compile a swift module.
## API
``yaml
```yaml
tasks:
build:
tool: atllbuild
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment