Merge pull request 'Fix #3: Add README.md' (#4) from proj/add-readme into master

Reviewed-on: #4
This commit is contained in:
bob 2024-11-26 14:36:45 +01:00
commit 63ea16d9e1

33
README.md Normal file
View File

@ -0,0 +1,33 @@
# 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`.
## 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`