X-Git-Url: https://git.danieliu.xyz/?p=sped.git;a=blobdiff_plain;f=README.md;h=066480687d1964cd8267e2e2929963830c4c7c34;hp=13bcd2450fdbd4225756d4b4adcc24a8fa88aba2;hb=aab6303fb9c43a2d727774c25b3c50a4b1fcae8d;hpb=2505d1841221648a72e768f23a5a475c8e1c01d1

diff --git a/README.md b/README.md
index 13bcd24..0664806 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,37 @@
 ## SPED - the stupidly pointless editor
+
+**sped** is a line editor written in x86 assembly. Back in the day, before visual editors, line editors like **ed** were used.
+This is my own stupid and pointless attempt at writing such line editor.
+
+### FEATURES/NON-FEATURES
+
+
+
+### INSTALLATION
+
+#### Build from source
+
+With `gcc` and `nasm` installed, you can simply run
+```
+make
+```
+to build the project
+
+### COMMANDS
+
+**p** - prints the contents of the current line
+
+**n** - prints the current line number
+
+**+/-** - moves up/down a line
+
+**g/G** - jumps to top/bottom of file
+
+**c** - change the contents of the current line
+
+### FAQ
+
+**are you insane**
+
+yes
+