From e0ae3732406aa270381dfe7b363424788ad53c7a Mon Sep 17 00:00:00 2001 From: Jasper Date: Tue, 6 Dec 2022 23:51:18 +1100 Subject: [PATCH] Update README.md --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8374f8e..e88f3aa 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,5 @@ # LiA ##### A transpiled superset of TeX because some of TeX's syntax was annoying me. - This is more for my personal use however you're welcome to use it or contribute. These added features are just designed to make LaTeX code less verbose, faster to write but also just catered more towards my personal preference. > For a more detailed explanation of the features see the [documentation](docs.md). @@ -77,3 +76,18 @@ use graphicx, [utf8]inputenc \end{itemize} \end{document} ``` +# Installation +* __Windows:__ Download the latest release from the [releases page](https://github.com/jaspwr/LiA/releases). There is currently no installer so you will need to add the directory to your path manually. +* __Other:__ Follow the instructions in the [building](#building) section. +# Usage +```bash +lia file.lia +``` +* Run `lia --help` for more information on usage. +# Building +Requires [Rust](https://www.rust-lang.org/tools/install) to be installed. +```bash +git clone https://github.com/jaspwr/LiA +cd LiA +cargo install --path +``` \ No newline at end of file