Compare commits

...

4 Commits

Author SHA1 Message Date
3a857e8980 Add visual note 2024-12-19 09:13:40 +01:00
46c4a1ac97 Fix links in README 2024-11-26 14:47:10 +01:00
bob
63ea16d9e1 Merge pull request 'Fix #3: Add README.md' (#4) from proj/add-readme into master
Reviewed-on: #4
2024-11-26 14:36:45 +01:00
6355b545e5 Add README.md 2024-11-26 14:34:16 +01:00

36
README.md Normal file
View File

@ -0,0 +1,36 @@
# curly — Working solution to the Krul puzzle
This tool will run a small compiler which implements the language from the [Krul
puzzle](https://bobpolis.com/krul/). The sources also contain an older
implementation, to be found in the interpreter files. This could also be used as
a drop-in replacement for the compiler, by changing the appropriate line in
`main.cpp`.
> [!Note]
> Running `curly` without arguments, it will show the solution to the online puzzle. When run with file arguments, it will try to parse those files as Krul sources and run them.
## Building
Build using:
`make`,
but first install the dependencies:
- [libsclogging](https://git.bobpolis.com/bob/libsclogging)
- [libscterm](https://git.bobpolis.com/bob/libscterm)
- [libscrequest](https://git.bobpolis.com/bob/libscrequest)
- libcurl
## Install
`sudo make install`
or, on OpenBSD:
`doas gmake install`
## Run
`curly`