X-Git-Url: https://git.danieliu.xyz/?a=blobdiff_plain;f=README.md;h=7f87c88b993e9cd0caed23c5a1ba079b15ee3abe;hb=737708d2a5e6ec61079236484c0a4c8234206ea8;hp=13bcd2450fdbd4225756d4b4adcc24a8fa88aba2;hpb=4c9d6b68e0b493e23969b79e96457b68cfed8895;p=sped.git

diff --git a/README.md b/README.md
index 13bcd24..7f87c88 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,45 @@
 ## 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.
+
+### 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
+
+**o/O** - insert line after/before current line
+
+**d** - delete current line
+
+**w** - saves file
+
+**q** - exists the program
+
+### FAQ
+
+**what is the point of this**
+
+obviously, we live in a day and age where we have the comfort of visual editors, so line editors like these have become obsolete. i simply wanted to work on a relatively easy to implement project so i can learn some assembly.
+
+**are you insane**
+
+yes
+