From ae96a76e23e5f60774eb8149b3513b2fc7d625d0 Mon Sep 17 00:00:00 2001 From: Timothy Warren Date: Tue, 3 Sep 2019 16:39:12 -0400 Subject: [PATCH] Update readme --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5eaecf9..bb3596b 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,14 @@ +# Oxidized Kilo + An experimental reimplementation of the [Kilo](https://viewsourcecode.org/snaptoken/kilo/index.html) -tutorial with a Rust implementation. \ No newline at end of file +tutorial with a Rust implementation. + +## Implementation notes: +* The `editor` prefix has been removed from all the editor methods. Since this implementation +uses `impl`s on a shared `Editor` struct, the prefix is redundant +* Any C equivalent functionality based on memory allocating/deallocating, or other manual book-keeping is instead +implemented in a more idiomatic Rust fashion. + + +### Known issues: +* The cursor is invisible :( \ No newline at end of file