https://github.com/audio-engineer/aau-p1-article
AAU SW1 P1 project article
https://github.com/audio-engineer/aau-p1-article
Last synced: about 1 year ago
JSON representation
AAU SW1 P1 project article
- Host: GitHub
- URL: https://github.com/audio-engineer/aau-p1-article
- Owner: audio-engineer
- Archived: true
- Created: 2023-10-27T09:46:57.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-16T17:53:35.000Z (over 2 years ago)
- Last Synced: 2025-03-11T02:48:20.534Z (over 1 year ago)
- Language: TeX
- Homepage:
- Size: 4.69 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# AAU P1 project (Group 4)
## Prerequisites
Make sure that you have [`textidote`](https://sylvainhalle.github.io/textidote/) installed on your system, so that you
can lint the project files before committing to the repository.
### TeXtidote usage
The `textidote` executable should be run in the project directory.
It will read the contents of the [`.textidote`](./.textidote) configuration file and use them as the arguments for the
program.
The `TeXtidote` GitHub Action reads the same configuration file and thus uses the same options when running `TeXtidote`.
On Windows:
```shell
java -jar textidote.jar src/main.tex
```
On Unix-like operating systems:
```shell
textidote src/main.tex
```
## To do
