Merge pull request #122 from Servostar/121-update-readme

121 update readme
This commit is contained in:
servostar 2024-06-06 22:45:15 +02:00 committed by GitHub
commit bf6de9c313
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 23 additions and 7 deletions

View File

@ -1,17 +1,31 @@
# Gemstone
Gemstone is a programming language compiler written in C with lex and yacc.
<div align="center">
<picture>
<img alt="gemstone logo" src="https://github.com/Servostar/gemstone/assets/72654954/fdb37c1b-81ca-4e6a-a9e9-c46effb12dae" width="75%">
</picture>
</div>
<br>
## Gemstone
Gemstone is a programming language compiler (short: GSC) written in C based on flex and GNU bison.
It uses LLVM to produce optimized native binaries for many platforms and uses its own builtin build system for more complex project management.
## Dependencies (build)
### Windows 11
For setup instruction see issue #30
Requires:
- Microsoft Build Tools 2022 (includes: CMake, MSVC)
- WinFlexBison [find it here](https://github.com/lexxmark/winflexbison) (needs to be in PATH)
#### MSYS2
Install MSYS2 under Windows 11. Open the MingGW64 environment.
Install the following packages:
```
pacman -S mingw-w64-x86_64-gcc mingw-w64-x86_64-glib2 bison flex mingw-w64-x86_64-llvm cmake git make
```
Clone the repository and build the gemstone compiler:
```
cmake . && make release
```
### GNU/Linux
Requires:
@ -20,6 +34,8 @@ Requires:
- Make
- bison
- flex
- LLVM
- Glib 2.0
## Writing Tests