From 0e35830c0a6c1d686e3d7a2c5b03184df0885af7 Mon Sep 17 00:00:00 2001 From: Rishi Advani Date: Wed, 8 May 2024 18:57:55 -0500 Subject: [PATCH] Add details and instructions to README --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index da634ca..438027b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,16 @@ # hw-latex-template -This is a simple template for writing up your math or CS homework in LaTeX. +This is a simple template for typesetting homework solutions in LaTeX. + +It is designed for math and computer science assignments, but would work for any discipline (within reason). It can also be adapted (by the TeX-savvy user) to work for other types of documents (e.g., research papers) by adjusting the formatting as necessary. + + +## Getting Started + +You will need a working LaTeX installation on your computer or access to an online service like Overleaf. + +- Put `hw_template.tex` into your project directory. +- Address the "TODO" comments in the source. +- Add your content after `\begin{document}`. + +See `hw_template.pdf` for an example of what the resulting output will look like.