Update README

minoki · Dec 9, 2023 · 8df26e5 · 8df26e5
1 parent e0603ed
commit 8df26e5
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # LunarML
 
-A Standard ML compiler that produces Lua/JavaScript.
+The Standard ML compiler that produces Lua/JavaScript.
 
 ## Trying pre-built binaries
 
@@ -13,7 +13,7 @@ $ lua example/hello.lua
 Hello world!
 ```
 
-## Building
+## Building and Installing
 
 You need a recent version of MLton to build the executable, and Lua 5.3+ or recent Node.js to run the compiled script.
 
@@ -29,6 +29,14 @@ $ lua example/hello.lua
 Hello world!
 ```
 
+You can install the built binary with `make install`:
+
+```
+$ make install PREFIX=/opt/lunarml
+$ export PATH="/opt/lunarml/bin:$PATH"
+$ lunarml compile example/hello.sml
+```
+
 Alternatively, you can use Docker to build and run LunarML.
 
 ```sh-session

diff --git a/doc/JavaScriptInterface.md b/doc/JavaScriptInterface.md
@@ -130,6 +130,8 @@ Note on CPS mode: You cannot call certain functions including `print` at top-lev
 
 ## Internal representation
 
+Warning: The internal representation of data types may change in the future. Do not rely on it!
+
 Primitives
 
 * `unit` (empty record): `undefined`

diff --git a/doc/LuaInterface.md b/doc/LuaInterface.md
@@ -306,6 +306,8 @@ return {
 
 ## Internal representation
 
+Warning: The internal representation of data types may change in the future. Do not rely on it!
+
 Primitives
 
 * `unit` (empty record): `nil`.