Skip to content

Commit a08e9ac

Browse files
authored
add Readme notes
1 parent 04b1e06 commit a08e9ac

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

install-and-run.sh

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,33 @@
11
#!/usr/bin/env bash
2+
# IOIBot Setup Script
3+
#
4+
# This script installs dependencies, creates a Python virtual environment,
5+
# copies the default config file if missing, and generates a systemd user
6+
# service to run the bot.
7+
#
8+
# USAGE:
9+
# ./install-and-setup.sh
10+
#
11+
# WHAT IT DOES:
12+
# - Creates a Python virtual environment in ./env
13+
# - Installs project dependencies with pip
14+
# - Verifies that data/config.yaml exists
15+
# - Generates a systemd user service at ~/.config/systemd/user/ioibot2025.service
16+
#
17+
# TO START THE BOT:
18+
# systemctl --user start ioibot2025.service
19+
#
20+
# TO VIEW LOGS:
21+
# journalctl --user -u ioibot2025.service -f
22+
#
23+
# NOTES:
24+
# - You must edit 'data/sample.config.yaml' and save it as 'data/config.yaml'
25+
# before starting the bot.
26+
# - You must set the environment variables VOTING_USERNAME and VOTING_PASSWORD
27+
# in the systemd service file:
28+
# ~/.config/systemd/user/ioibot2025.service
29+
# These are required for the bot to work properly.
30+
231
set -euo pipefail
332

433
# Variable names

0 commit comments

Comments
 (0)