{"id":13998310,"url":"https://github.com/detiuaveiro/ua-thesis-template","last_synced_at":"2025-07-23T06:31:15.111Z","repository":{"id":41136659,"uuid":"146627528","full_name":"detiuaveiro/ua-thesis-template","owner":"detiuaveiro","description":"📖 A thesis LaTeX template that complies with the University of Aveiro's guidelines and provides a simple CLI workflow around make and compatibility with Overleaf.","archived":false,"fork":false,"pushed_at":"2024-10-31T18:56:02.000Z","size":2798,"stargazers_count":109,"open_issues_count":7,"forks_count":42,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-10-31T19:28:14.767Z","etag":null,"topics":["dissertation","latex","latexmk","msc","phd","thesis"],"latest_commit_sha":null,"homepage":"","language":"TeX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/detiuaveiro.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-08-29T16:23:44.000Z","updated_at":"2024-10-31T18:56:06.000Z","dependencies_parsed_at":"2023-02-12T11:46:54.061Z","dependency_job_id":"186b98c7-9360-4cbc-9b6e-df00c0d081a8","html_url":"https://github.com/detiuaveiro/ua-thesis-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/detiuaveiro%2Fua-thesis-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/detiuaveiro%2Fua-thesis-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/detiuaveiro%2Fua-thesis-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/detiuaveiro%2Fua-thesis-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/detiuaveiro","download_url":"https://codeload.github.com/detiuaveiro/ua-thesis-template/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227245149,"owners_count":17753239,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dissertation","latex","latexmk","msc","phd","thesis"],"created_at":"2024-08-09T19:01:34.026Z","updated_at":"2024-11-30T00:31:25.242Z","avatar_url":"https://github.com/detiuaveiro.png","language":"TeX","funding_links":[],"categories":["Popular \u0026 New LaTeX Templates","TeX"],"sub_categories":["Thesis/Dissertation"],"readme":"# University of Aveiro Thesis Template\n\nA thesis LaTeX template that complies with the University of Aveiro's\nguidelines and provides a simple CLI workflow around `make` that was developed\nand tested for cross-compatibility on Linux (Slackware, ArchLinux, Debian, Ubuntu) and macOS.\n\nThis template was developed by professors and students. \nWe will try to keep up to date with thesis requirements but some discrepancies may exist.\nFeel free to open issues and pull requests with new options, packages and fixes.\n\n## Usage\n\nOptional: In debian and ubuntu you can install all dependencies automatically:\n\n```\nmake setup\n```\n\nBuild a development version of the document:\n\n```\nmake [build]\n```\n\nContinuously build the development version of the document:\n\n```\nmake preview\n```\n\nThis option is great when paired with a document viewer (such as Okular) which\nautomatically reloads the document on file change. This means you can keep\nwriting and on save the updated document is compiled and displayed!\n\nBuild versions of the document for publishing:\n\n```\nmake print\nmake ebook\n```\n\nRun linters (for now only [proselint](http://proselint.com/)) against a TeX\nfile (e.g. chapter 1):\n\n```\nmake lint [texfile=chapter1.tex]\n```\n\nIf you do not specify the `texfile` to lint, then all TeX files in `chapters/`\nwill be linted.\n\nClean the build directory:\n\n```\nmake clean[all]\n```\n\n`clean` will leave the output products (the PDFs) in place, while `cleanall`\nwill remove these too. If your document is not compiling for some reason and\nyou think you've already solved the problem in the LaTeX sources, maybe try a\n`cleanall` before insisting. Sometimes the underlying build programs (namely\n`latexmk`) get stuck in inconsistent temporary files.\n\n## How to use the template\n\nThis is all great, but how can this repository be used as a starting point for\nwriting your own thesis?\n\nIn our opinion you have mostly three options:\n- Download/clone the repository and copy *all* files to a directory of your\n  desire, for instance to inside some special folder within you own thesis\n  repository.  \n  Notice that this will not allow you to easily keep up with this template\n  should it change.\n- Fork the repository to your own and work there. If you want to include it\n  within your own thesis repository, you can use `git submodules` for this.\n- Use `git subtree` to pull this repository to your main thesis repository and\n  work directly there. Changes in your copy will be versioned by your main\n  thesis repo, while you will still be able to pull new updates from here\n  should they appear.\n\nThe last of these options mas be the most adquate, as it seems to be the most flexible and\neasy-to-use alternative. Here follow the main commands you will need should you\nchoose to go along with this too.\n```\n$ mkdir mythesis\n$ git init .\n$ git commit --allow-empty -n -m \"Initial commit.\"\n$ git subtree add  --prefix document https://github.com/detiuaveiro/ua-thesis-template.git master --squash;\n$ git subtree pull --prefix document https://github.com/detiuaveiro/ua-thesis-template.git master --squash;\n```\n\n- The first line will init a new repository for your thesis\n- It will create an initial commit\n- It will pull this repository for the first time to `document`\n- The second is used for subsequent pulls.\n\nThe result should be a git repository for your thesis work. In the `$DESTDIR` (e.g. `document`)\nyou will have the document to edit. If you wish you can add a reference to another git repository\nto track your own changes.\n\n## Use as a template in github\n\nPlease check the [github instructions](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)\nto create your own repository using this as a template.\n\n## Use it in [Overleaf](https://www.overleaf.com)\n\nIt is possible to use this template in overleaf.\n\nTo enable it:\n\n- in `matter.tex` change `\\def\\useoverleaf{0}`to 1\n- add `fc-portuges.def` to the project the file be can found in [here](http://mirrors.ctan.org/install/macros/latex/contrib/fmtcount.tds.zip) \n- change the main document to `matter.tex`\n\n## Dependencies\n\n- A TeX distribution: TeX Live or MacTeX\n- gs (for `make print`, `make ebook` and `simplify-colors.sh`)\n- pandoc (for `make lint`)\n- imagemagick and poppler (for `simplify-colors.sh`)\n- pygments (for minted)\n\nAs for pygments and proselint, those can by installed with pip by issuing `pip\ninstall -r requirements.txt` at the root of this repository.\n\nOn Ubuntu relatives the following dependencies, installable with `apt` may\nalso be required\n- biber\n- texlive-bibtex-extra\n- texlive-latex-extra\n- texlive-science\n\nThese endorsed dependencies which may or may not come with the TeX Live package\ndistributed with your Linux distribution.\n\nUsually TeX Live is split into a minimal package and a `texlive-extra` which is\nfilled with the remainder of TeX Live, be it fonts, styles, language support,\nand so on. So, if a LaTeX dependency is missing on your installation, do verify\nthat you are not missing one of these packages.\n\n## Authors\n\nTomás Oliveira e Silva created the [original\ntemplate](http://sweet.ua.pt/tos/TeX/ua_thesis.tgz) which was later picked up\nby João Paulo Barraca who [improved and maintained it for\nyears](http://code.ua.pt//projects/latex-ua/repository).\n\nThis is a fork by Fábio Maia and Ricardo Jesus who wanted to further improve\nthe template and setup a clean environment and workflow for writing their MSc\nthesis.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdetiuaveiro%2Fua-thesis-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdetiuaveiro%2Fua-thesis-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdetiuaveiro%2Fua-thesis-template/lists"}