From f4e3e27dd0b56ac39f0f6242d3464df764ab2a61 Mon Sep 17 00:00:00 2001
From: lemon <lsof@mailbox.org>
Date: Sun, 14 Sep 2025 19:41:28 +0200
Subject: license and readme

---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..895dd15
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+`antcc` is a C compiler using its own custom backend. Currently still in a
+experimental stage.
+
+# Supported targets
+
+- For now just x86-64 POSIX (Sys-V + ELF). Only tested on linux so far.
+
+# Building
+
+```
+make   # outputs ./antcc executable
+# or
+make opt #compile with optimizations
+# or
+make dbg #compile with UBsan and Asan
+```
+
+
+# Usage
+
+The driver is still incomplete but it mimics that of compilers like gcc.
+`antcc` compiles translation units to object files directly, but the driver
+will invoke an external linker command to output an executable if `-c` isn't passed.
-- 
cgit v1.2.3