aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMasaya Tojo <masaya@tojo.tokyo>2022-05-15 14:16:43 +0900
committerMasaya Tojo <masaya@tojo.tokyo>2022-05-15 14:16:43 +0900
commita39e21af4870387a05c86c34fc21c33329790b5b (patch)
treeb203d270bb2d4d5fe8bf488e8da13068a337b409
parentd9f774d5b1fb3f8070f761791dd37b1a7e1e36a3 (diff)
README: Update.
-rw-r--r--README.md18
1 files changed, 17 insertions, 1 deletions
diff --git a/README.md b/README.md
index d22bb8d..18e4ef2 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,19 @@
# ob-acl2
-ob-acl2 is a software to run acl2 on org-babel.
+**THIS CODE IS VERY DANGEROUS. It automatically executes an ACL2 program on the `*shell*` buffer.**
+
+Org-babel functions for ACL2.
+
+# Usage
+
+First, Run ACL2 in `*shell*` buffer of Emacs.
+
+```
+$ acl2
+```
+
+Second, use org-babel.
+
+# LICENSE
+
+See COPYING file.