Skip to content
This repository has been archived by the owner on Dec 19, 2023. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Saverio976 authored Dec 18, 2023
1 parent 2f061e1 commit 0c1c40d
Showing 1 changed file with 68 additions and 0 deletions.
68 changes: 68 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,69 @@
# koaky

A Blazzing Light Lisp Interpreter

## Features

- Condition
- [x] `if`
- [x] `eq?`
- [x] `diff?`
- [x] `<`
- [x] `>`
- [x] `>=`
- [x] `<=`
- Operator
- [x] `+`
- [x] `-`
- [x] `*`
- [x] `div`
- [x] `mod`
- Type
- [x] `Integer`
- [x] `Boolean`
- [x] `Symbol`
- Function
- [x] `lambda`
- [x] `define`
- Error Handling
- [x] Error handling at execution time
- [x] Nice error message at execution time
- [x] Error handling at parsing time
- [ ] Nice error message at parsing time

## Install

2 methods to use this interpreter:
- from available binary
- build from source

### From Available Binary

- Download the binary for your platform in the latest release.

### Build From Source

- Clone this repository: <https://github.com/X-R-G-B/koaky.git>
- Install stack: <https://docs.haskellstack.org/en/stable/>
- `cd`'d in the repository you just cloned
- Run: `stack build --copy-bins --local-bin-path .`
- The binary will be available with the name `koaky-exe.exe`:windows `koaky-exe`:linux `koaky-exe`:macos

## Usage

```
Usage: koaky-exe [OPTION]
Interpret Lisp
With no options, koaky reads from standard input.
Options:
-h, --help
Display this help and exit
-v, --version
Output version information and exit
-f FILE, --file FILE
Read FILE and Interpret it
-
Read from standard input and Interpret it
```

0 comments on commit 0c1c40d

Please sign in to comment.