Skip to content

Commit

Permalink
Update README with more instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
nuric committed Jun 4, 2024
1 parent 7bc2460 commit 5cfe1d8
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,23 @@ A minimal VS Code LaTex template using Docker containers to compile. It contains
- Format and compile on file save.
- Invert PDF colours using the extension settings, `.vscode/settings.json`.

The main motivation behind this setup is the extremely tedius and unhelpful native LaTex installation process. Using a Docker container to wrap `pdflatex` and more allows for a cleaner and more reproducible workspace.
The main motivation behind this setup is the extremely tedious and unhelpful native LaTex installation process. Using a Docker container to wrap `pdflatex` and more allows for a cleaner and more reproducible workspace.

## Getting started

Use the "Use this template" button to create a new repository with this template. Clone the repository and open it in VS Code. The first time you open the project, you will be prompted to install the recommended extensions. Click "Install All" to install them.

To compile the latex project:

1. Open the [main.tex](main.tex) file and find TEX extension in the left sidebar. It appears only when you have the LaTex Workshop extension installed and have a Tex file open.
2. Click the "Build LaTeX project" button to compile the project. The PDF will be generated using the Docker container.
3. After the compilation, click the "View LaTeX PDF" option button to view the generated PDF!

When you push, the same compilation process will be run on GitHub Actions. The PDF will be available as an artifact in the actions tab.

## Contributing

The objective is to keep this template as minimal as possible. For issues, suggestions, or improvements, please open an issue or a pull request.

## Built using

Expand Down

0 comments on commit 5cfe1d8

Please sign in to comment.