···11# GitHub Grader Preview
2233-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.
33+Simple program that runs test cases specified in an autograding.json file and
44+reports results. Useful for previewing how GitHub will run your autograder and
55+project.
4657> [!WARNING]
66->
77-> While this works on Windows, the GitHub classroom runner uses Linux by default, and so some professors may write commands
88-> specific to Linux meaning they won't work for you.
88+>
99+> While this works on Windows, the GitHub classroom runner uses Linux by
1010+> default, and so some professors may write commands specific to Linux meaning
1111+> they won't work for you.
9121013## Usage
1114···1316gh-grader-preview
1417```
15181616-Will auto-find the `autograding.json` file located in `.github/classroom` relative to the current dir.
1919+Will auto-find the `autograding.json` file located in `.github/classroom`
2020+relative to the current dir.
17211822You can specify `-f` to choose a different file.
1923···35393640### Installation
37413838-Copy the binary from `target/release/gh-grader-preview` to a directory in your PATH.
4242+Copy the binary from `target/release/gh-grader-preview` to a directory in your
4343+PATH.
39444040-Run `gh-grader-preview --man-page` to print the man page to stdout, and then save it to a file.
4545+Run `gh-grader-preview --man-page` to print the man page to stdout, and then
4646+save it to a file.
41474242-Run `gh-grader-preview --completions=SHELL` (replace `SHELL` with `bash`, `fish`, or `zsh`) to generate a shell completion script.
4848+Run `gh-grader-preview --completions=SHELL` (replace `SHELL` with `bash`,
4949+`fish`, or `zsh`) to generate a shell completion script.