fspl/fspl
fspl/fspl
1
0
Fork 0
Code Issues 16 Pull Requests Packages Projects 1 Releases 6 Wiki Activity

Add some extra notes to readme

Browse Source
This commit is contained in:
Sasha Koshka 2023-12-13 03:44:57 -05:00
parent 9ea5deb23a
commit 91eb3e8e9e
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -19,8 +19,10 @@ You can install the compiler by running:
`go install ./cmd/fsplc`
The `fsplc` program depends on the LLVM IR compiler (`llc`). Please ensure it is
installed and accessible from your PATH before using this software.
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
ensure either `llc` or `clang` are installed and accessible from your PATH
before using this software.
Note that the compiler is still relatively early in development, and has
numerous bugs. In addition, language features and syntax are not yet set in
@ -51,6 +53,10 @@ choice, or by using a C compiler such as `clang`:
Using a C compiler will link the C standard library to your program, which may
be useful for building normal user applications.
## Bugs
There are a lot of them. But something to be wary of, especially on Windows:
currently, the compiler only excepts files with a blank line at the end.
## Roadmap
### Late 2023