diff --git a/README.md b/README.md index e8077bf..3a23e6a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,12 @@ -### TODO -- Don't provide ncurses source code - Tell the user to compile it with the given flags in the README file. +### TedFlex - a File Explorer / Text Editor +TedFlex is an ncurses-based File Explorer and Text Editor application, written in C. +
+It uses a custom-compiled version of ncurses, and will likely crash if used with a regular ncurses library. +The following steps are used to compile the version of ncurses that this program needs: +- Grab the ncurses source code from [here](https://invisible-mirror.net/archives/ncurses/ncurses-6.3.tar.gz) +- Run the configure script with the '--with-pthread --with-shared' options. +- Run 'make' and 'make install'. + + + +