Skip to content

docs: unify README, setup guide, and description#55

Merged
Firestone82 merged 2 commits into
masterfrom
docs/unify-readme
Jun 20, 2026
Merged

docs: unify README, setup guide, and description#55
Firestone82 merged 2 commits into
masterfrom
docs/unify-readme

Conversation

@Firestone82

Copy link
Copy Markdown
Owner

Standardizes the README format and updates the repository description for consistency across all public repositories.

Changes:

  • Unified section structure: About, Features, Requirements, Setup, Configuration (where applicable), License
  • School projects clearly marked with VŠB-TUO attribution and course name/code
  • Personal projects updated with accurate descriptions and real config examples
  • Repository description updated

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 3de50009fe

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md Outdated
### Discord bot setup

1. Go to [discord.com/developers/applications](https://discord.com/developers/applications) and create a new application.
2. Under **Bot**, enable the **Message Content Intent** and **Server Members Intent**.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Include the Presence Intent in setup

When someone follows these new bot setup instructions, the application only enables Message Content and Server Members, but the client requests GatewayIntents::GUILD_PRESENCES in src/bot.rs. For a freshly created Discord app where the Presence Intent is still disabled, Discord rejects the gateway connection for disallowed intents, so the bot will fail to start until this privileged intent is enabled or the code stops requesting it.

Useful? React with 👍 / 👎.

Comment thread README.md

4. Set up the database:
```bash
sqlx database create

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Install sqlx-cli before invoking sqlx

This setup step now calls sqlx database create on a clean checkout without ever installing the sqlx CLI. A standard Rust install only provides Cargo/Rust tools, so users following the README hit sqlx: command not found before they can create the SQLite database or run migrations; the previous instructions included cargo install sqlx-cli before these commands.

Useful? React with 👍 / 👎.

@Firestone82
Firestone82 merged commit 012df9c into master Jun 20, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant