Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
JustinMeimar committed Oct 17, 2024
1 parent 7dd57b0 commit 23c2272
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 8 deletions.
25 changes: 17 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
# Dragon-Runner

Dragon-Runner is a successor to the [415-tester](https://github.com/cmput415/Tester). Its name is derrived from being a test runner for a compiler class that likes dragon iconography.

<div align="center">
<div style="background-color: #f0f0f0; border-radius: 10px; padding: 10px; display: inline-block;">
<img alt="Dragon-Runner Logo" src="/docs/logo-bg-256.png" width="250">
</div>

# Dragon-Runner
#### A Custom Test Runner for CMPUT 415
<div style="background-color: #f0f0f0; border-radius: 10px; padding: 10px; display: inline-block;">
<img alt="Dragon-Runner Logo" src="/docs/runner-log.png" width="90">
</div>
</div>
<br>

Dragon-Runner is a successor to the [415-tester](https://github.com/cmput415/Tester). Its name is derived by being a test runner for a compiler class that likes dragon iconography.

## Design
Dragon-Runner inherits much of the previous testers design but with greater emphasis on the following aspects:

* Simplicity: Sub 1000 lines
* Reliability: Each step of the toolchain is observable to a configurable degree.
* User Experience: Warn when paths do not exist in the config, throw more informed errors when toolchains panic and improve debug support.
* Design: Define clear boundaries between the front, middle and backend.
* Speed: When python becomes a bottle neck, a multi-threaded dynamic library is ready to churn through tests in parallel (FUTURE TODO).

## Building

Expand All @@ -30,3 +30,12 @@ pip install .
dragon-runner --help
```
If `dragon-runner` is not found on `$PATH` try adding `~/.local/bin`


## Running

Dragon runner implements the same config semantics as the [415-tester](https://github.com/cmput415/Tester). Reference the documentation there in lieu of a complete migration.

## Contributing

Please feel free to make a PR. The previous tester had plenty of contributions from students.
Binary file added docs/runner-log.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 23c2272

Please sign in to comment.