[DOCS] adding description for each subdirectory

.github/Readme.md

@@ -0,0 +1,3 @@
+# .github
+
+This directory contains all workflows, issue templates and the depandabot configuration

examples/Readme.md

@@ -0,0 +1,5 @@
+# Examples
+
+This directory contains ygens examples.
+
+`obj.rs` is only for those of you using ygens object`-crate wrapper

src/CodeGen/Readme.md

@@ -0,0 +1,5 @@
+# CodeGen
+
+This directory defines code for lowering the Ir to Lir (portable machine code of architectures).
+
+To view the generation of machine epended code consider taking a look at `Target/the_arch_you_want_to_see`

src/CodeGen/compilation/Readme.md

@@ -0,0 +1,3 @@
+# Compilation
+
+This directory contains the code to lower ir nodes into lir

src/IR/Readme.md

@@ -0,0 +1,3 @@
+# IR
+
+This directory includes the entire ygen-Frontend and ygen-Ir (+ parsing)

src/IR/nodes/Readme.md

@@ -0,0 +1,3 @@
+# nodes
+
+This directory defines all ir nodes

src/IR/parser/Readme.md

@@ -0,0 +1,3 @@
+# parser
+
+This directory allows for the textual representation of ygen to being parsed and turned into a module

src/Obj/Readme.md

@@ -0,0 +1,3 @@
+# Obj
+
+This directory contains wrapper code for easier usage of the object crate

src/Optimizations/Passes/Readme.md

@@ -0,0 +1,3 @@
+# Passes
+
+Contains runnable "Optimization-Passes"

src/Optimizations/Readme.md

@@ -0,0 +1,3 @@
+# Optimizations
+
+In this directory there is the code to run optimizations and the actuall optimizations in the [Passes](https:://github.com/Cr0a3/ygen/tree/main/src/Optimizations/Passes) subdirectory

src/Readme.md

@@ -0,0 +1,15 @@
+# src
+
+Ygens source code is splitted into (now) 7 subdirectorys:
+|Name|Description|
+|------|---------------|
+|[CodeGen](https://github.com/Cr0a3/ygen/tree/main/src/CodeGen)|Shared code generation files (generates LIR)|
+|[IR](https://github.com/Cr0a3/ygen/tree/main/src/IR)|Definition for all ir nodes and the ir lang|
+|[Obj](https:://github.com/Cr0a3/ygen/tree/main/src/Obj)|Wrapper around the object and gimli libary to generate objects/excutables/shared libarys|
+|[Optimizations](https:://github.com/Cr0a3/ygen/tree/main/src/Optimizations)|Contains optimizations for ygen-ir|
+|[proc](https:://github.com/Cr0a3/ygen/tree/main/src/proc)|Ygens procedual macros|
+|[Support](https:://github.com/Cr0a3/ygen/tree/main/src/Support)|Utility functions and classes|
+|[Target](https:://github.com/Cr0a3/ygen/tree/main/src/Target)|Target depended code like instruction encoding, lir lowering, assembly|
+|[debug.rs](https:://github.com/Cr0a3/ygen/tree/main/src/debug.rs)|Contains code for constructing debug metadata used by the `ObjectBuilder`|
+
+For more information about each one refer to the ygen-dev guide

src/Support/Readme.md

@@ -0,0 +1,3 @@
+# Support
+
+This directory contains utility functions and classes

src/Target/Readme.md

@@ -0,0 +1,3 @@
+# Target
+
+Contains target depended code

src/Target/x64/Readme.md

@@ -0,0 +1,5 @@
+# x64
+
+This directory contains the code for lowering ir into machine instrs ([lower.rs](https://github.com/Cr0a3/ygen/tree/main/src/Target/x64/lower.rs))
+
+Also assembly parsing and instructione encoding in the subdirectory [asm](https://github.com/Cr0a3/ygen/tree/main/src/Target/x64/asm/)

src/Target/x64/asm/Readme.md

@@ -0,0 +1,3 @@
+# x64 - asm
+
+This directory contains instruction encoding and assembly parsing, optimization

src/proc/Readme.md

@@ -0,0 +1,3 @@
+# proc
+
+This directory defines all of ygens procedual macros

tests/Readme.md

@@ -0,0 +1,5 @@
+# Tests
+
+This directory contains all tests of ygen
+
+Many tests have the file format `.yl`. These are ytest files with ygen-ir.

tools/simplelang/Readme.md

@@ -0,0 +1,7 @@
+# Simplelang
+
+This directory contains the simplelang example.
+
+It's an example programming language made in Rust using ygen.
+
+The lexer is made using the logos libary, the rest is handwritten (exept the backend, that's done with ygen).

tools/ygen-mc/Readme.md

@@ -0,0 +1,3 @@
+# Ygen-mc
+
+This directory contains `ygen-mc`. It is used to test assembly parsing and code generation

tools/ylc/Readme.md

@@ -0,0 +1,4 @@
+# Ylc
+
+This directory contains `ylc`.
+Which is the compiler of ygen-ir. (Like llc from which i took the name)

tools/ytest/Readme.md

@@ -0,0 +1,3 @@
+# Ytest
+
+This directory contains `ytest` which is the testing application used for testing ygen

web/Readme.md

@@ -0,0 +1,7 @@
+# Web
+
+This directory contains ygens website source code.
+
+It is made using `Next.js`, `Tailwind CSS`and `shadcn/ui``
+
+It's automaticly deployed to [ygen.vercel.app](ygen.vercel.app)