add readme and license
[oftp] / README.md
1 oftp - ftp client with dual-pane text-mode UI
2 =============================================
3
4 oftp is a text-mode graphical ftp client, with a dual-pane UI , also known as
5 the "orthodox" file management UI paradigm. The dual-pane UI design is a perfect
6 fit for an FTP client, where the user is required to navigate two filesystems
7 simultaneously; one pane is dedicated to the remote filesystem served over ftp,
8 while the other is for navigating the local filesystem.
9
10 oftp was written to address the lack of graphical FTP clients for DOS (MS-DOS,
11 FreeDOS, etc), but will also run on UNIX systems using curses for its UI.
12
13 License
14 -------
15 Copyright (C) John Tsiombikas <nuclear@mutantstargoat.com>
16
17 This program is free software. Feel free to use, modify, and/or redistribute it
18 under the terms of the GNU General Public License version 3, or any later
19 version published by the Free Software Foundation. See COPYING for details.
20
21 Hotkeys
22 -------
23   - TAB: switch active pane
24   - F5: copy selected (upload/download)
25   - F7: create new directory
26   - F8: delete selected
27   - F10: quit
28   - `~`: force UI redraw