aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: c690fb45656ad0bd5bc3f3464c8e5f0b821e3b81 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
# Installation

As you have read these words, you are to install *HALK*.

```
$ sudo make install
```

If you wish to remove all *HALK*-related items from your life, you can try

```
$ sudo make uninstall
```

# Usage

One must simply

```
$ halk examples/simple.halk
```

. Simply running *HALK* with no arguments allows one to send arbitrary text.
An example session is displayed below:

```
$ halk
> :str:var = 'Hello, World.';
> ^D
[==] lexer created
[==] BEGIN INPUT
:str:var = 'Hello, World.';
[==] END INPUT
[==] token type: [TOKEN_DEF_TAG]    token value: [str]
[==] token type: [TOKEN_DEF_TAG]    token value: [var]
[==] token type: [TOKEN_DEF_SET]    token value: [=]
[==] token type: [TOKEN_PRIM_STR]      token value: [Hello, World.]
[==] token type: [TOKEN_EXPR_END]      token value: [;]
[==] token type: [TOKEN_EOF]     token value: []
[==] source file closed
```

# Syntax

*HALK* is a **dubiously-typed**, **vaguely-functional**, **interpreted**  programming language, with syntax designed to be as
**minimal** and **consistent** as possible.
Note that all syntax described is liable to sudden and violent change.

Example programs can be found [here](tree/examples).

- [x] Preprocessor
- [ ] Lexer
- [ ] Abstract Syntax Tree
- [ ] Parser
- [ ] Doer
- [ ] ?? profit ??