diff --git a/README.md b/README.md index e8d45a9..e6b3a8f 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,19 @@ # Really Bad Compiler in Haskell -A compiler written in Haskell which can currently perform basic arithmetic. Currently using the megaparsec and llvm-hs-\* libraries, but I plan to reimplement parsing and llvm generation myself. Built for the Introduction to Compiler Design class at The University of Texas at Dallas. +A compiler written in Haskell which can currently perform basic arithmetic. Currently using the megaparsec and llvm-hs-\* libraries, but I may reimplement certain libraries myself. Built for the Introduction to Compiler Design class at The University of Texas at Dallas. Main repo: https://git.sudoer.ch/me/really-bad-compiler-in-haskell -## Build Instructions +## Setup Instructions - Install `ghcup` (for managing Haskell tools) and `nix` (for managing external dependencies). - Clone the repo. - Use `ghcup` to install `stack 2.9.3`, `HLS 2.2.0.0`, `GHC 9.2.8`, and `cabal 3.6.2.0`. + +## Run Instructions + - Use `stack run ` to run the program (for example, `stack run example/1`). +- The LLVM will be generated as `a.out.ll`, and the executable will be generated as `a.out`. ## To edit