···1# GitHub Grader Preview
23-Simple program that runs test cases specified in an autograding.json file and reports results. Useful for previewing how GitHub will run your autograder and project.
0045> [!WARNING]
6->
7-> While this works on Windows, the GitHub classroom runner uses Linux by default, and so some professors may write commands
8-> specific to Linux meaning they won't work for you.
0910## Usage
11···13gh-grader-preview
14```
1516-Will auto-find the `autograding.json` file located in `.github/classroom` relative to the current dir.
01718You can specify `-f` to choose a different file.
19···3536### Installation
3738-Copy the binary from `target/release/gh-grader-preview` to a directory in your PATH.
03940-Run `gh-grader-preview --man-page` to print the man page to stdout, and then save it to a file.
04142-Run `gh-grader-preview --completions=SHELL` (replace `SHELL` with `bash`, `fish`, or `zsh`) to generate a shell completion script.
0
···1# GitHub Grader Preview
23+Simple program that runs test cases specified in an autograding.json file and
4+reports results. Useful for previewing how GitHub will run your autograder and
5+project.
67> [!WARNING]
8+>
9+> While this works on Windows, the GitHub classroom runner uses Linux by
10+> default, and so some professors may write commands specific to Linux meaning
11+> they won't work for you.
1213## Usage
14···16gh-grader-preview
17```
1819+Will auto-find the `autograding.json` file located in `.github/classroom`
20+relative to the current dir.
2122You can specify `-f` to choose a different file.
23···3940### Installation
4142+Copy the binary from `target/release/gh-grader-preview` to a directory in your
43+PATH.
4445+Run `gh-grader-preview --man-page` to print the man page to stdout, and then
46+save it to a file.
4748+Run `gh-grader-preview --completions=SHELL` (replace `SHELL` with `bash`,
49+`fish`, or `zsh`) to generate a shell completion script.