Add README.md

This commit is contained in:
Sierra 2023-07-06 17:47:20 +00:00
parent 968479d0e8
commit 1a62a08478

20
README.md Normal file
View file

@ -0,0 +1,20 @@
# Runner
Runner is a program to run multiple executables in parallel. I mostly use it to run a server program while also rebuilding a frontend in the background.
The configuration for it is through a kdl file in the directory it is invoked from. Here's an example config file:
```kdl
run "frontend" {
path "frontend"
command "npm"
args "run" "dev"
}
run "backend" {
path "backend"
command "cargo"
args "run" "--color=always"
}
```
This builds a frontend through npm and a cargo server to actually run the backend server.
It takes paths to run the commands in as their working directory, arguments are optional if not needed.