docs: unify README, setup guide, and description - #10
Conversation
There was a problem hiding this comment.
💡 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".
|
|
||
| 1. Compile the document: | ||
| ```bash | ||
| pdflatex main.tex |
There was a problem hiding this comment.
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 👍 / 👎.
Standardizes the README format and updates the repository description for consistency across all public repositories.
Changes: