diff options
| author | Fuwn <[email protected]> | 2021-05-11 10:23:05 +0000 |
|---|---|---|
| committer | Fuwn <[email protected]> | 2021-05-11 10:23:05 +0000 |
| commit | d96cf5047e94ef62999b0979afd5dc439fd8d195 (patch) | |
| tree | 7ff7a0fd48d27aa8efedd87285fa2d091a913684 | |
| parent | ci(make): create act-cli task (diff) | |
| download | whirl-d96cf5047e94ef62999b0979afd5dc439fd8d195.tar.xz whirl-d96cf5047e94ef62999b0979afd5dc439fd8d195.zip | |
docs: add act documentation, fix up ok docs
| -rw-r--r-- | docs/act.md | 12 | ||||
| -rw-r--r-- | docs/ok.md | 4 |
2 files changed, 14 insertions, 2 deletions
diff --git a/docs/act.md b/docs/act.md new file mode 100644 index 0000000..97ab6ae --- /dev/null +++ b/docs/act.md @@ -0,0 +1,12 @@ +# act + +## Usage + +### Prerequisites +- [Act](https://github.com/nektos/act) +- [Docker](https://www.docker.com/) + +### Executing +```shell +$ act # Executes all GitHub actions (there is only one) +``` @@ -3,7 +3,7 @@ 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 +## Current configuration (outdated) 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 @@ -19,5 +19,5 @@ Bonus points for being written in Rust! ### Executing ```shell -$ ok # in the root directory +$ ok # In the root directory of this repository ``` |