dev-notes.md

Contribution and Developing Rules and Notes

Rules

1. To contribute to this repository, please install latexindent.pl or TeX package latexindent for formatting TeX files.

2. (Optional) Install the VS Code extension LaTeX Workshop.

3. In Ubuntu, please also set up the dependencies of latexindent as follows.install the apt package libyaml-tiny-perl to provide YAML::Tiny. (ref. )

   # install the perl package management tool "cpanm" system-wide
   sudo cpan -i App::cpanminus
   
   # install the perl package dependencies system-wide
   sudo cpanm YAML::Tiny
   sudo cpanm File::HomeDir

4. In Arch Linux, please install the following packages for latexindent to work.

   sudo pacman -S texlive-binextra perl-yaml-tiny

   Reasons (click to expand/hide):

   texlive-binextra provides latexindent and allows VS Code to access latexmk command that LaTeX Workshop requires. (References: ref.1, ref.2)

   perl-yaml-tiny provides the YAML::Tiny module that latexindent required. (Reference)

Notes for Maintainers

Make a New Release

1. To release handouts and syllabus on GitHub, for now, please build them in Docker for a consistent environment, and add the files to a release manually.

Publish the Environment Image to Docker Hub

1. Generate an access token from the settings page with permissions to read, write, delete images.

2. In a Linux machine, log in Docker Hub with the token.

   docker login -u rays2

3. Build the handout-environment image.

   cd src/environments
   ./build-handout-env.sh

4. (Optional) Check the compiling result.

   cd ../builders
   ./build-main-handout-linux.sh

5. Push the images to Docker Hub.

   docker push rays2/gt-handout-env --all-tags