Clarify install instructions in README.md

This commit is contained in:
Sasha Koshka 2024-04-19 08:31:57 +00:00
parent 1085cfdc3c
commit 3bc504aae6

View File

@ -19,9 +19,11 @@ This language is designed for:
- Compiler must avoid generating logic that the user does not write
## Installation
You can install the compiler by running:
Before installing the compiler with `go install`, you will need to install the
[Go programming language](https://go.dev/) on your system. Afterwards, you can
install the compiler and associated tooling by running:
`go install ./cmd/fsplc`
`go install ./cmd/*`
The `fsplc` program depends on the LLVM IR compiler (`llc`). If it is not found,
it will attempt to use `clang` instead but with some features disabled. Please