Skip to content

Commit 4244be2

Browse files
committed
Fix: readme
1 parent c6804b4 commit 4244be2

File tree

1 file changed

+35
-2
lines changed

1 file changed

+35
-2
lines changed

README.md

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,36 @@
1-
# Popcorn CLI (Rust Version)
1+
# Popcorn CLI
22

3-
Run `./build.sh` and then ` POPCORN_API_URL="http://127.0.0.1:8000" target/release/popcorn-cli ../../discord/discord-cluster-manager/reference-kernels/problems/pmpp/grayscale_py/submission.py`
3+
A command-line interface tool for submitting solutions to the [Popcorn Discord Bot](https://github.com/gpu-mode/discord-cluster-manager)
4+
5+
## Installation
6+
7+
### Option 1: Using pre-built binaries (Recommended)
8+
9+
1. Download the latest release for your platform from the releases page
10+
2. Extract the archive
11+
3. Move the binary to a location in your PATH
12+
13+
### Option 2: Building from source
14+
15+
This app is written in Rust, so you can just install it via `cargo install`
16+
17+
## Usage
18+
19+
Set the `POPCORN_API_URL` environment variable to the URL of the Popcorn API. You can get this from the [GPU Mode Discord server](https://discord.gg/gpumode).
20+
21+
Then, you need to be registered to use this app. You can register by running: `popcorn-cli register [discord|github]`. We strongly reccomend using your Discord account to register, as this will match your submissions to your Discord account.
22+
Once you're registered, there is a file created in your `$HOME` called `.popcorn-cli.yaml` that contains your registration token. This token is sent with each request.
23+
24+
If you want to re-register (you can do this any number of times), you can run `popcorn-cli reregister [discord|github]`.
25+
26+
After this, you can submit a solution by running:
27+
28+
```bash
29+
popcorn-cli submit <submission-file>
30+
```
31+
32+
The interactive CLI will guide you through the process of:
33+
1. Selecting a leaderboard
34+
2. Selecting GPU options
35+
3. Setting submission mode
36+
4. Submitting your work

0 commit comments

Comments
 (0)