From 71f6368bf5a1b810dbf92a91ed4b3ee15b39cd90 Mon Sep 17 00:00:00 2001
From: xkm <xkm@xkm.be>
Date: Thu, 4 Dec 2025 18:51:31 +0800
Subject: [PATCH] feat: add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..59aca2c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# SFDL - Simple Function Draw Language
+
+
+## 实现语法:
+
+- `scale is (x, y);`
+- `origin is (x, y);`
+- `rot is x;`
+- `for t from a to b step k draw( t, t );`
+
+## 运行方法
+
+得益于本项目使用go语言且无第三方库，基本上任何电脑均可编译运行
+
+首先电脑上得装go语言包，然后直接在本项目目录运行
+```sh
+go run . your_sfdl_file.sfdl
+```
+
+运行后结果会保存在`out.png`
+
+也可以先编译本项目再运行：
+```sh
+go build
+./sfdl your_sfdl_file.sfdl
+```
+
+当然你也许可以直接下载二进制文件（项目地址：https://gitea.starryskymeow.cn/xkm/sfdl）
\ No newline at end of file