From 363e5c0de3ee201dc4ef4a51bb1f0eb11b0b90a4 Mon Sep 17 00:00:00 2001 From: nihirash Date: Tue, 2 Jul 2019 20:22:44 +0000 Subject: [PATCH] readme added --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..fab6721 --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# uGoph - gopher client for ZX-Uno(and possible other zx-spectrums) + +## Requirements + +For running you need: + * ZX-Uno(or compatible) zx-spectrum clone with UART core + * Stored WiFi creds via [.iwconfig](https://github.com/nihirash/iwconfig) utility. + +For development you need only sjasmplus. + +Sadly, but there no emulator with ZX-Uno's UART. + +## Supported features + +Current version supports: + + * Rendering gopher-pages(catalogs) + * Navigation between pages and servers + * Rendering plain-text pages + * Downloading binary files to SD card + * Opening specified server(only by root path) + +## Legals + +(c) 2019 Alexander Sharikhin + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see .