From 2c142b34a806b7c3482b13ca9b65ed0c83d06e46 Mon Sep 17 00:00:00 2001 From: TheCPP Date: Wed, 4 Sep 2024 18:35:42 +0200 Subject: [PATCH] [DOCS] changching readme --- README.md | 15 ++++++++++----- tmp.yl | 1 - 2 files changed, 10 insertions(+), 6 deletions(-) delete mode 100644 tmp.yl diff --git a/README.md b/README.md index 143c6e7e..487143c1 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,17 @@ # Ygen - Yet another Code Generator -Ygen is a libary to build backends for compilers. +![GitHub branch check runs](https://img.shields.io/github/check-runs/Cr0a3/ygen/main?style=flat-square&label=build) +![Crates.io Version](https://img.shields.io/crates/v/Ygen?style=flat-square) +![GitHub Repo stars](https://img.shields.io/github/stars/cr0a3/ygen?style=flat-square) -Its primary focus is having an really easy to use API like LLVMSwift (ygen is also implemented easily so everybody can add their own ir nodes and the compilation backends). +Ygen is a libary for building compiler backends. -It has some advantages over llvm like being more memory safe cuz it's written in rust. -But it also lacks many ir nodes, usable optimization techniques, tools and contributours. +It provides easy to use apis for generating ygen-ir, which is also lowerable to machine code using easy to use class method. + +The main focus is code generation but it also has support classes like for coloring. + +> [!WARNING] +> This project is still early in its developement. Bugs and miscompilations are expected. DO NOT USE THE PROJECT FOR NOT TOY COMPILERS -The IR doesn't differ to much from LLVMs. ### Contributions diff --git a/tmp.yl b/tmp.yl deleted file mode 100644 index 5f3430c6..00000000 --- a/tmp.yl +++ /dev/null @@ -1 +0,0 @@ -const .const0 = "Hello World!\n"define void @main() { entry: %0 = ptr .const0 %1 = call void printf ptr %0 ret void 0}declare void @printf( ptr %0, ... )Hello World! \ No newline at end of file