From 02b1d5ed84bbeaa40b5ac82d5505309b5b679711 Mon Sep 17 00:00:00 2001
From: xushiwei <x@goplus.org>
Date: Mon, 6 May 2024 12:31:55 +0800
Subject: [PATCH] README

---
 README.md                           | 35 +++++++++++++++++++++++++++++
 {demo => _demo}/genints/gen_ints.go |  0
 2 files changed, 35 insertions(+)
 rename {demo => _demo}/genints/gen_ints.go (100%)

diff --git a/README.md b/README.md
index eb1e3c12..4815d9ea 100644
--- a/README.md
+++ b/README.md
@@ -9,3 +9,38 @@ llgo - A Go compiler based on LLVM
 [![Language](https://img.shields.io/badge/language-Go+-blue.svg)](https://github.com/goplus/gop)
 
 This is a Go compiler based on LLVM in order to better integrate Go with the C ecosystem. It's a subproject of [the Go+ project](https://github.com/goplus/gop).
+
+## How to install
+
+Follow these steps to generate the `llgo` command (its usage is the same as the `go` command):
+
+### on macOS
+
+```sh
+brew update  # execute if needed
+brew install llvm@17
+go install -v ./...
+```
+
+### on Linux
+
+```sh
+echo 'deb http://apt.llvm.org/focal/ llvm-toolchain-focal-17 main' | sudo tee /etc/apt/sources.list.d/llvm.list
+wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add -
+sudo apt-get update  # execute if needed
+sudo apt-get install --no-install-recommends llvm-17-dev
+go install -v ./...
+```
+
+## Demo
+
+The examples of `llgo` are all in the `_demo` directory (it start with `_` to prevent the `go` command from compiling it):
+
+* _demo/genints: closure usage in llgo
+
+### How to run demos
+
+```sh
+cd <demo-directory>  # eg. cd _demo/genints
+llgo run .
+```
diff --git a/demo/genints/gen_ints.go b/_demo/genints/gen_ints.go
similarity index 100%
rename from demo/genints/gen_ints.go
rename to _demo/genints/gen_ints.go