fixed warnings on GCC, fixed opening an absolute path, README

1 files changed, 52 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..57fce19
--- /dev/null
+++ b/README.md
@@ -0,0 +1,52 @@
+# ted
+
+A text editor.
+
+**ted is still very new, and there are almost certainly bugs. There are also definitely important features missing. I don't recommend using this as your main text editor yet.**
+
+<img src="ted.png">
+
+To install `ted` on Linux, you will need:
+
+- A C compiler
+- SDL2
+- The GL development libraries
+
+These can be installed on Ubuntu/Debian with:
+
+```
+sudo apt install gcc libsdl2-dev libgl-dev
+```
+
+Then run
+
+```
+sudo make install -j4
+```
+
+There is no nice way of installing on Windows yet.
+
+## Why?
+
+There are a lot of text editors out there. ted doesn't do anything new.
+But in the modern world of text editors running browsers internally, it can be nice to have
+a simple editor that starts up practically instantaneously, and performs well on reasonably-sized files.
+
+## Supported features (more coming soon)
+
+- Multiple tabs, each with a different file
+- Auto-indent
+- Customization of (pretty much) all colours and keyboard commands.
+
+## Building from source
+
+On Linux, run `make`; on Windows, run `make.bat`.
+
+## License
+
+ted is in the public domain (see `LICENSE.txt`).
+
+## Reporting bugs
+
+You can report a bug by sending an email to `pommicket at pommicket.com`.
+