final clean up
[sped.git] / README.md
1 ## SPED - the stupidly pointless editor
2
3 **sped** is a line editor written in x86 assembly. Back in the day, before visual editors, line editors like **ed** were used.
4 This is my own stupid and pointless attempt at writing such line editor.
5
6 ### INSTALLATION
7
8 #### Build from source
9
10 with `gcc` and `nasm` installed, you can simply run
11 ```
12 sudo make install
13 ```
14 to build the project
15
16 ### USAGE/COMMANDS
17
18 **sped** takes a single command line argument, the file you wish to open.
19 ```
20 sped [file]
21 ```
22
23 **p** - prints the contents of the current line
24
25 **n** - prints the current line number
26
27 **+/-** - moves up/down a line
28
29 **g/G** - jumps to top/bottom of file
30
31 **c** - change the contents of the current line
32
33 **o/O** - insert line after/before current line
34
35 **d** - delete current line
36
37 **w** - saves file
38
39 **q** - exists the program
40
41 ### FAQ
42
43 **what is the point of this**
44
45 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.
46
47 **are you insane**
48
49 yes
50