Skip to content

Commit 75d3b4e

Browse files
committed
Update README.md
1 parent 190ec34 commit 75d3b4e

File tree

1 file changed

+19
-13
lines changed

1 file changed

+19
-13
lines changed

README.md

+19-13
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,20 @@
1-
# golox: a lox tree-walk interpreter written in Go
1+
# golisp: a lisp (yisp) tree-walk interpreter written in Go
22

3-
This is a working interpreter of the Lox language, as
4-
used in the book Crafting Interpreters by Robert Nystrom
3+
This is a working interpreter for a subset of the Lisp language (aka Yisp)
4+
as outlined by Don Yessick for CS403 at the University of Alabama
55

6-
This interpreter is feature complete through Chapter 10
7-
of Crafting Interpreters, meaning it implements variables,
8-
printing, loops, control flow, and functions (complete with
9-
working return statements and control flow). Does NOT include variable resolution, classes, or inheritence <sub>(yuck)</sub>
6+
This interpreter is feature complete for the language as defined by Yessick
7+
Notes on choices made:
108

11-
Current native functions include: ```clock()```, and ```toStr(number)```
9+
```true``` is the truth value
10+
11+
```nil``` used for false/nil value
12+
13+
```=``` used for equality checking
14+
15+
```cond``` used for conditional statements
16+
17+
The language is not case sensitive
1218

1319
# Instructions
1420

@@ -21,15 +27,15 @@ $ go version
2127

2228
Finally, clone the repository into the current directory with
2329
```
24-
$ git clone https://github.com/reilandeubank/golox
30+
$ git clone https://github.com/reilandeubank/golisp
2531
```
2632
or into ```path/to/directory``` using
2733
```
28-
$ git clone https://github.com/reilandeubank/golox path/to/directory
34+
$ git clone https://github.com/reilandeubank/golisp path/to/directory
2935
```
3036

3137
## Compiling
32-
First, move into the ```golox``` directory that was just created
38+
First, move into the ```golisp``` directory that was just created
3339

3440
From here, you can use the ```make``` command to compile the interpreter into the executable ```./main``` in the current directory.
3541

@@ -45,7 +51,7 @@ $ ./main
4551
```
4652
to start a REPL or
4753
```
48-
$ ./main file.lox
54+
$ ./main file.lsp
4955
```
50-
to run ```file.lox```
56+
to run ```file.lsp```
5157

0 commit comments

Comments
 (0)