LaTeX Class Notes

Collaborative effort to build up a notes repository for ACSAI A.Y 2022/2023's last semester.

View PDF · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

The repository collects my notes built with a somewhat overengineered LaTeX template + snippets, the idea is sharing information about the lectures with the whole class and also having collaboration in the form of pull requests/issues through Github.

(back to top)

Built With:

• 
• 

(back to top)

Getting Started

For instructions with contributing to the project, see the Contributing section.

If you want to build the project locally to make your own changes, follow the steps below.

Prerequisites

In order to run LaTeX you need to have a TeX distribution installed on your machine, I recommend using one that updates your packages on the go, such as:

• Windows: MiKTeX
• Mac: MiKTeX
• Linux: Tectonic, fairly new but it's a great alternative to TeXLive.

Installation

1. Clone the repo

   git clone https://github.com/dario-loi/last-year-notes.git

2. (Optional) Set up VSCode for LaTeX development:
   • Install LaTeX Workshop
   • Install LaTeX Utilities
3. Install the pre-commit hooks:
   • Install pre-commit
   • Run pre-commit install in the root of the repository

And you are ready to go!

(back to top)

Roadmap

• Add a CI/CD pipeline to automatically build and release the PDF.
• Create chapter for slides number 2.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

In order to contribute (update, fix, add) to the project, follow the steps below:

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

In the pull request, please specify the changes you made and why you think they should be merged.

If you notice a bug/error in the notes, or you want to suggest a new feature, please open an issue.

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - dloi.projects@gmail.com

Project Link: https://github.com/dario-loi/last-year-notes

(back to top)

Acknowledgments

• Gilles Castel
• sleepymalc

(back to top)