Skip to content

Commit

Permalink
Update SETUP.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ShyftXero authored Jul 26, 2024
1 parent 767eabe commit 63eaaac
Showing 1 changed file with 24 additions and 3 deletions.
27 changes: 24 additions & 3 deletions SETUP.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,27 @@
# Setup
# Web only variant
I've started using uv for project and dependency management.
https://astral.sh/blog/uv

Running this software requires a Discord bot. Create one with the following instructions:
See my helper aliases for managing virtual envs -> https://gist.github.com/ShyftXero/e2b5c02108ce426e426f872cd3d47cb0

```
curl -fsSL https://gist.githubusercontent.com/ShyftXero/e2b5c02108ce426e426f872cd3d47cb0/raw/uv_venv.sh >> ~/.zshrc
git clone https://github.com/ShyftXero/byoctf_discord
cd byoctf_discord
uv venv venv --python=3.11
source venv/bin/activate
uv pip install -r pyproject.toml
./ctrl_ctf.py DEV_RESET
python scoreboard.py
```



you should be able to git clone and `uv pip install

# Discord Setup

Running this software ~~requires~~ used to require a Discord bot. Create one with the following instructions:

- Login to Discord and visit https://discord.com/developers/applications/
- Click "New Application" and give it a name
Expand Down Expand Up @@ -57,4 +78,4 @@ Now you will need to edit a few files and install some dependencies.
- Make sure to send your commands via a direct message to the bot. Avoid public channels. Here are some good initial commands to test out and confirm your setup.
- `!help`
- `!reg TEAM TEAMPASS`


0 comments on commit 63eaaac

Please sign in to comment.