Skip to content

Commit b71dd0a

Browse files
committed
Improve README
1 parent bea3536 commit b71dd0a

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
A command-line interface tool for submitting solutions to the [Popcorn Discord Bot](https://github.com/gpu-mode/discord-cluster-manager)
44

5+
Tested on linux and mac but should just work on Windows as well.
6+
57
## Installation
68

79
### Option 1: Using pre-built binaries (Recommended)
@@ -12,16 +14,23 @@ A command-line interface tool for submitting solutions to the [Popcorn Discord B
1214

1315
### Option 2: Building from source
1416

15-
This app is written in Rust, so you can just install it via `cargo install`
17+
1. Download rust `curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh`
18+
2. `cd popcorn-cli && cargo install --path .`
1619

17-
## Usage
20+
## Authentication
1821

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).
22+
Since we're effectively giving out GPUs for free we rely on either github or discord authentication to prove that you're a real human before you access our service.
23+
24+
1. Go to the [GPU Mode Discord server](https://discord.gg/gpumode) and type in `/get-api-url/`
25+
2. Copy paste that url out `export POPCORN_API_URL="result_of_get_api_url"`
26+
3. We recommend you authenticate via your Discord as this will guarantee that your name will show up correctly on the leaderboard, you can do this via `popcorn-cli register discord`. However in case this doesn't work for you we also support Github based authentication with `popcorn-cli register github`
27+
4. To ensure the above worked you can run `cat $HOME/.popcorn.yaml` which should print your client ID which is what will be sent to us on every request
2028

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.
29+
Sometimes you'll get an error that you're already authenticated despite being unable to submit in which case you can run `popcorn-cli reregister [discord|github]`.
2330

24-
If you want to re-register (you can do this any number of times), you can run `popcorn-cli reregister [discord|github]`.
31+
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).
32+
33+
## Make your first submission
2534

2635
After this, you can submit a solution by running:
2736

@@ -34,3 +43,5 @@ The interactive CLI will guide you through the process of:
3443
2. Selecting GPU options
3544
3. Setting submission mode
3645
4. Submitting your work
46+
47+
glhf!

0 commit comments

Comments
 (0)