requirements.txt: adding the requirements text file

1 files changed, 36 insertions, 0 deletions

diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..7edc6a1
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,36 @@
+Requirements of an editor for Kui Yo to use
+===========================================
+
+FORMAT
+------
+
+Let's say I want to require the editor to have the key-binding that
+runs command F by pressing key K.  Then just write as follows.
+
+- key: "K" => "F"
+
+Now one might not know the name of the command in need.  So one can
+"define" a command by a description, as follows.
+
+- def: "F" <= DESCRIPTION
+
+
+
+EXAMPLE
+-------
+
+An example is easier to understand.  Suppose I want that pressing "C-x
+m", which means "control-x m", has the effect of copying the current
+line and pasting it below the current line.  Then I can write:
+
+- def: "copy line below" <= copying the current line and pasting it
+       below the current line
+- key: "C-x m" => "copy line below"
+
+
+
+REQUIREMENTS
+------------
+
+Now let's start the journey.
+