diff --git a/README.md b/README.md new file mode 100644 index 0000000..22b0b2e --- /dev/null +++ b/README.md @@ -0,0 +1,10 @@ +# PHP Kilo + +A reimplementation of the [Kilo](https://viewsourcecode.org/snaptoken/kilo/index.html) tutorial in PHP. Requires PHP 7.4, +due to requiring the `FFI` extension. + +## Implementation notes: + +* The `editor` prefix has been removed from all the relevant functions, instead they are methods on the `Editor` class. +* Enums are faked with class constants +* Generally, if a function exists in PHP, with the same name as the C function, the PHP version will be used. \ No newline at end of file