X-Git-Url: https://git.danieliu.xyz/?a=blobdiff_plain;f=README.md;h=2436d4840b9229bcd0390ff90e3fd54924460c6e;hb=0e7c787c5d6e31bd64fb9348c1cc4704d5b5928e;hp=13bcd2450fdbd4225756d4b4adcc24a8fa88aba2;hpb=4c9d6b68e0b493e23969b79e96457b68cfed8895;p=sped.git

diff --git a/README.md b/README.md
index 13bcd24..2436d48 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,41 @@
 ## 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
+
+**w** - saves file
+
+**q** - exists the program
+
+### FAQ
+
+**are you insane**
+
+yes
+