Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Firestone82 merged 2 commits into from
Jun 20, 2026
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b030454
docs: unify README format, setup guide, and description
Firestone82 Jun 20, 2026
39e6893
docs: unify README format, setup guide, and description
Firestone82 Jun 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Master-Thesis

LaTeX source for my Master's thesis: *LLM-Assisted Code Review in Kelvin*, VŠB-TUO, 2025.

![LaTeX](https://img.shields.io/badge/LaTeX-TeX-blue)

## About

This repository contains the complete LaTeX source of my Master's thesis submitted at VŠB-TUO, Faculty of Electrical Engineering and Computer Science. The thesis documents the design and implementation of LLM-powered automated code review within [Kelvin](https://kelvin.cs.vsb.cz) — the code examination platform used at VŠB-TUO. It covers prompt engineering, integration of OpenAI-compatible models into the Kelvin evaluation pipeline, and quality evaluation against human-authored feedback.

The Kelvin platform itself is at [Firestone82/kelvin](https://github.com/Firestone82/kelvin).

## Build

Requires a full TeX Live or MiKTeX installation.

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

@chatgpt-codex-connector chatgpt-codex-connector Bot Jun 20, 2026

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 👍 / 👎.

biber main
pdflatex main.tex
pdflatex main.tex
```

Or open `main.tex` in [Overleaf](https://overleaf.com) or TeXstudio for a GUI workflow.

## License

© Pavel Mikula, 2025. All rights reserved. The thesis text may not be reproduced without permission.
Loading