From 638caa355cee8ed7ba1ffe170bc6bdde44d3549c Mon Sep 17 00:00:00 2001
From: xushiwei <x@goplus.org>
Date: Thu, 16 May 2024 06:34:18 +0800
Subject: [PATCH] Development tools

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/README.md b/README.md
index 28ad7ba0..fad5c9ea 100644
--- a/README.md
+++ b/README.md
@@ -213,3 +213,19 @@ go install -v ./...
 ### on Windows
 
 TODO
+
+
+## Development tools
+
+* [pydump](chore/_xtool/pydump): It's the first program compiled by `llgo` (NOT `go`) in a production environment. It outputs symbol information (functions, variables, and constants) from a Python library in JSON format, preparing for the generation of corresponding packages in `llgo`.
+* [llpyg](chore/llpyg): It is used to automatically convert Python libraries into Go packages that `llgo` can import. It depends on `pydump` to accomplish the task.
+* [llgen](chore/llgen): It is used to compile Go packages into LLVM IR files (*.ll).
+* [ssadump](chore/ssadump): It is a Go SSA builder and interpreter.
+
+How do I generate these tools?
+
+```sh
+go install -v ./...  # compile all tools except pydump
+cd chore/_xtool
+llgo install ./...   # compile pydump
+```