cleanup and human facing notesHEADmaster

1 files changed, 16 insertions, 0 deletions

diff --git a/README b/README
index e4cbce0..8be20a0 100644
--- a/README
+++ b/README
@@ -1,3 +1,19 @@
+TCCQ's fork of vi
+=========================
+
+This is a small fork of a port of vi to modern posix systems. The changes
+are primarily aimed at making compile and work with musl. Specifically
+instead of allocating scratch space with sbrk it just preallocates a 
+large (64MB) buffer in .bss and relies on OS level paging to not waste
+more physical memory than is necessary. Note that this means that the 
+memory usage is unlikely to decrease meaningfully after going up. 
+For vi which often doesn't have super long running sessions I deem this
+acceptable.
+
+This version compiles and works nicely with tinycc and/or musl. Any C99
+compiler should work fine.
+
+
 Welcome to the ex/vi port!
 ==========================