add readme and license

[oftp] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..ae642d0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+oftp - ftp client with dual-pane text-mode UI
+=============================================
+
+oftp is a text-mode graphical ftp client, with a dual-pane UI , also known as
+the "orthodox" file management UI paradigm. The dual-pane UI design is a perfect
+fit for an FTP client, where the user is required to navigate two filesystems
+simultaneously; one pane is dedicated to the remote filesystem served over ftp,
+while the other is for navigating the local filesystem.
+
+oftp was written to address the lack of graphical FTP clients for DOS (MS-DOS,
+FreeDOS, etc), but will also run on UNIX systems using curses for its UI.
+
+License
+-------
+Copyright (C) John Tsiombikas <nuclear@mutantstargoat.com>
+
+This program is free software. Feel free to use, modify, and/or redistribute it
+under the terms of the GNU General Public License version 3, or any later
+version published by the Free Software Foundation. See COPYING for details.
+
+Hotkeys
+-------
+  - TAB: switch active pane
+  - F5: copy selected (upload/download)
+  - F7: create new directory
+  - F8: delete selected
+  - F10: quit
+  - `~`: force UI redraw