Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/susickypavel/ctuthesis
CTU in Prague thesis template
https://github.com/susickypavel/ctuthesis
latex
Last synced: 2 months ago
JSON representation
CTU in Prague thesis template
- Host: GitHub
- URL: https://github.com/susickypavel/ctuthesis
- Owner: susickypavel
- License: other
- Created: 2023-10-10T10:58:31.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-05T11:58:34.000Z (about 1 year ago)
- Last Synced: 2024-10-11T15:15:40.738Z (3 months ago)
- Topics: latex
- Language: TeX
- Homepage:
- Size: 9.4 MB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ctuthesis
This repository is a fork of https://github.com/tohecz/ctuthesis. Most of the original files are present, but the folder structure is cleaner to work with. It's designed to work well with Visual Studio Code and a LaTeX workshop extension.
# 1. Installation
## 1.1 Prerequisites
- [**Visual Studio Code**](https://code.visualstudio.com)
- [**VSCode LaTeX workshop extension**](https://marketplace.visualstudio.com/items?itemName=James-Yu.latex-workshop)
- [**TexLive**](https://tug.org/texlive) or other TexLive distribution such as [**TinyTex**](https://yihui.org/tinytex)
> [!NOTE]
> I'd suggest TinyTex if you're comfortable installing missing packages since the installation size is substantially reduced. See required packages below.
### 1.1.1 Required LaTeX packages
Most of the required packages are included in the full distribution of TexLive. If you're an advanced user with custom Tex distribution (such as TinyTex), below are some of the packages that you might be missing. You can copy the command to install all of them with the `tlmgr` package manager below.
- [**biblatex**](https://bibtex.eu/cs/biblatex/)
- [**csquotes**](https://ctan.org/pkg/csquotes)
- [**environ**](https://www.ctan.org/pkg/environ)
- [**microtype**](https://www.ctan.org/pkg/microtype)
- [**pdfpages**](https://www.ctan.org/pkg/pdfpages)
- [**titlesec**](https://www.ctan.org/pkg/titlesec)
- [**fancyhdr**](https://www.ctan.org/pkg/fancyhdr)
- [**caption**](https://www.ctan.org/pkg/caption)
- [**pdflscape**](https://www.ctan.org/pkg/pdflscape)
- [**biber**](https://www.ctan.org/pkg/biber)
- [**makeindex**](https://www.ctan.org/pkg/makeindex)
- [**babel-czech**](https://www.ctan.org/pkg/babel-czech)
- [**babel-english**](https://www.ctan.org/pkg/babel-english)
- hyphen-czech
```sh
tlmgr install biblatex csquotes environ microtype pdfpages titlesec fancyhdr caption pdflscape biber makeindex babel-czech babel-english hyphen-czech
```
### 1.1.2 Optional LaTeX packages
These packages aren't needed for the compilation of the project to work. However, they can enhance your experience with linting and formatting your LaTeX code.
- [chktex](https://www.ctan.org/pkg/chktex)
- [latexindent](https://www.ctan.org/pkg/latexindent)
- [texcount](https://ctan.org/pkg/texcount)
```sh
tlmgr install chktex latexindent texcount
```
## 1.2 Usage
1. Make sure you have all the [**prerequisites**](#11-prerequisites)
2. Open the [**workspace file**](./.vscode/thesis.code-workspace) using Visual Studio Code
3. Open `thesis.tex` (your root file, this should include all the other `*.tex` files)
4. Make your changes and hit save
5. `.build` folder should be generated in the root of the workspace with bunch of intermediate files and a final [**pdf**](./.build/thesis.pdf).
6. Check out the original [**manual**](./manual.pdf) if you want to customize the thesis to your liking
7. Have fun writing your awesome thesis!
### 1.2.1 TODOs
To make your life a little bit easier, there are several `TODO` comments placed across the `*.tex` files to let you know that you should change their content before submitting your work.
# 2. Structure
```ini
✨ ctuthesis/ # Workspace root
├─ .build/ # Build directory (not in VCS)
│ ├─ thesis.pdf
├─ src/ # Source directory
│ ├─ assets/ # Asset directory, mainly CTU logo and font
│ │ ├─ ctu_logo_black.pdf
│ ├─ common/ # (almost) original ctuthesis *.tex files
│ │ ├─ ctuth-core.tex
│ │ ├─ ctuth-names.tex
│ │ ├─ ctuth-templates.tex
│ │ ├─ ctuth-pkg.tex
│ ├─ documents/ # Directory for all sorts of documents
│ │ ├─ zadani.pdf # Specification of your thesis
│ ├─ ctuthesis.cls # LaTeX class file that makes all the magic, don't worry about it too much.
│ ├─ thesis.ist # Formatting configuration for Index of the document
│ ├─ thesis.bib # Bibliography references
│ ├─ thesis.tex # Entry tex file for your thesis
├─ manual.pdf # Original ctuthesis manual
```