aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..54b9000
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+# Infix-to-Scheme
+
+Infix-to-Scheme is an R7RS library for converting infix formula to Scheme expression.
+
+## Usage
+
+### Import `(infix-to-scheme)` library
+
+```scheme
+(import (infix-to-scheme))
+```
+
+#### `(infix->scheme expr) → <sexpr>`
+
+Returns converted scheme expression if `expr` is a valid infix formula expression; otherwise, it returns`#f`.
+
+#### `(scheme->infix expr) → <sexpr>`
+
+Returns converted infix formula expression if `expr` is a valid scheme expression; otherwise, it returns`#f`.
+
+## Downloading code with git
+
+Use git command.
+
+```shell
+git clone https://git.tojo.tokyo/infix-to-scheme.git
+```
+
+## License
+
+This library is released under the GPLv3+ License.
+See the COPYING file for more details.
+
+## Copyright
+
+Copyright (c) 2024 Masaya Tojo <masaya@tojo.tokyo>