Skip to content

Commit

Permalink
docs: update README to include codespace support
Browse files Browse the repository at this point in the history
  • Loading branch information
kevin-secrist committed Jan 8, 2025
1 parent 12bfc7a commit 69094ce
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@

This project started as a proof of concept to compare templates for Microsoft Word and LaTeX templates. In the past when I have used LaTeX I was always very satisfied with the result, and I think the additional benefits of source control and CI/CD made this option very compelling.

# GitHub Codespace Support

This repo takes advantage of [dev containers](https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers), which natively works with [GitHub Codespaces](https://docs.github.com/en/codespaces/overview) allowing me to develop the project within a browser quite easily for quick changes.

# Local Development Setup

Building a LaTeX project locally normally requires a LaTeX environment which can be relatively painful to setup and there are numerous ways to do it incorrectly. I've found it much easier to run LaTeX within a container and follow the installation steps of other projects and developers who use LaTeX much more seriously.
Expand Down

0 comments on commit 69094ce

Please sign in to comment.