aboutsummaryrefslogtreecommitdiff
path: root/docs/ok.md
blob: 3c9803753a56ea0a444e4504ed912c451e751b28 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# ok

The [.ok](../.ok) file within the root directory is a file which is used to run various shell
commands in order, usually for testing.

## Current configuration
1. Lint and fix fixable linting warnings based on the [rustfmt.toml](../rustfmt.toml) file
2. Check for lint warnings and display
3. Check for any warnings and compilation errors

## Usage

### Prerequisites

An ok-file executor, I recommend [ok](https://github.com/juev/ok).

P.S.
Bonus points for being written in Rust!

### Executing
```shell
$ ok # in the root directory
```