Skip to content

Commit

Permalink
add installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
thacuber2a03 committed Jun 22, 2024
1 parent 87decd0 commit 71972bf
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,21 @@ the [Umka](https://github.com/vtereshkov/umka-lang) programming language.
- Carries timing information and keeps track of test results
- Can print testing information in a slick and straightforward format, or a verbose but insightful one

## Installation

### Manually

Download the "toast.um" file and place it somewhere in your project.
Then, import it in your test file.

### Through [UmBox](https://umbox.tophat2d.dev)

> [!WARNING]
> This will install the `master` branch version of the box, which might not be stable.
Run `umbox install toast`.
You can also run `umbox init toast` to make a new box with Umka and toast preinstalled.

## Usage

### Creating a new test suite
Expand Down

0 comments on commit 71972bf

Please sign in to comment.