Skip to content

docs: unify README, setup guide, and description - #10

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

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: b030454db3

ℹ️ 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

1. Compile the document:
```bash
pdflatex main.tex

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 Point the build command at the actual XeLaTeX entrypoint

Users following the README from the repository root cannot compile with this command: there is no root-level main.tex (the tree has src/main.tex, and the existing workflow builds with working_directory: src), and that file loads fontspec, so pdflatex is the wrong engine. In a fresh checkout this build section leads to immediate failure instead of producing the thesis PDF; update it to run from src with XeLaTeX/latexmk and the needed shell-escape settings.

Useful? React with 👍 / 👎.

@Firestone82
Firestone82 merged commit d7b0828 into master Jun 20, 2026
9 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