X-Git-Url: https://git.danieliu.xyz/?p=sped.git;a=blobdiff_plain;f=README.md;h=d4fc9f64000b34f8754bedf69600bfa49d7ed1ce;hp=4ea05df5d364070722c2dafe86d594f570348573;hb=HEAD;hpb=7a7ed6ae81978b84911dab0b902e77ebb7e9b735 diff --git a/README.md b/README.md index 4ea05df..d4fc9f6 100644 --- a/README.md +++ b/README.md @@ -3,21 +3,22 @@ **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 +sudo make install ``` to build the project -### COMMANDS +### USAGE/COMMANDS + +**sped** takes a single command line argument, the file you wish to open. +``` +sped [file] +``` **p** - prints the contents of the current line @@ -29,8 +30,20 @@ to build the project **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