summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCliff Click <cliffc@acm.org>2023-08-19 08:59:38 -0700
committerGitHub <noreply@github.com>2023-08-19 08:59:38 -0700
commit1571eeeb41c3af5cc2da23ce4edbc69cf53bd383 (patch)
treead4a630cf174fb290f8a15aec4e8ee99a524242c /README.md
parent3f770043d7ffaae52b2d5137491742684f4544c9 (diff)
downloadSimple-1571eeeb41c3af5cc2da23ce4edbc69cf53bd383.tar.gz
Simple-1571eeeb41c3af5cc2da23ce4edbc69cf53bd383.zip
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
index 75b27618..ba068fb9 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,10 @@
# Simple
A Simple showcase for the Sea-of-Nodes compiler IR
+
+This repo is intended to demonstrate the Sea-of-Nodes compiler IR.
+The Sea-of-Nodes is the core IR inside of HotSpot's C2 compiler and Google's V8 compiler and Sun/Oracle's Graal compiler.
+Since we are show casing the SoN IR, the *language* being implemented is less important.
+We're using a very simple language similar to C or Java, but with far fewer features.
+The Sea-of-Nodes is used for machine code generation in these industrial strength systems - but for this demonstration the backend is both difficult and less important.
+This repo also is not intended to be a complete language in any sense, and so the backend will probably start with levering C or Java.
+