https://github.com/fnogatz/thesis-makefile

Curated Makefile with best practices, conventions, and tips for writing LaTeX theses.
https://github.com/fnogatz/thesis-makefile

latex makefile thesis

Last synced: 25 days ago
JSON representation

Curated Makefile with best practices, conventions, and tips for writing LaTeX theses.

• Host: GitHub
• URL: https://github.com/fnogatz/thesis-makefile
• Owner: fnogatz
• License: mit
• Created: 2021-10-23T08:51:32.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-06-12T15:34:36.000Z (over 2 years ago)
• Last Synced: 2024-10-26T22:51:35.118Z (2 months ago)
• Topics: latex, makefile, thesis
• Language: Makefile
• Homepage:
• Size: 6.84 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Thesis Makefile

Curated Makefile with best practices, conventions, and tips for writing LaTeX theses. This is a single GNU Makefile that checks for common mistakes and enforces consistent source code. It only depends on standard Unix utilities that are likely to exist on any system. Just drop it in your source directory, change the settings in the Makefile's header, and run `make test`.

## Usage

To use this Makefile as a template in your own project, just place a copy in your project's root directory and modify the `SOURCES` setting in the Makefile's header. Then, the test can be called via `make test`.

Alternatively, it is possible to specify the location of the LaTeX source code files with the `SOURCES` environment variable:

```sh

make test SOURCES=/path/to/your/latex

```

The output reads as a recipe of what to pay attention to when writing your document. In case some rules fail, it states the corresponding lines as returned from `grep`.

Here's an example output that fails because of the duplicated `are` in the file `background.tex`:

```sh

make test SOURCES=/tmp/thesis ENGLISH=british

# --- British English ---

# Use `focusse[sd]` instead of `focuse[sd]`

# Use `modelled` instead of `modeled`

# Use `behaviour` instead of `behavior`

# Use `favour` instead of `favor`

# Use `flavour` instead of `flavor`

# Use `honour` instead of `honor`

# Use `colour` instead of `color` (but allow command `\color` if set anywhere)

# Use `organised` etc. instead of `organized`

# Use `the other way round` instead of `the other way around`

# --- Avoid common mistakes ---

# Do not put tilde in front of `\cref`

# Do not put blanks in front of or after tilde

# Avoid duplicate words

/tmp/thesis/background.tex:This chapter introduces some important terms and concepts which are are relevant to this thesis.

make: *** [Makefile:106: writing.common-mistakes] Error 1

```