Update README.md

This commit is contained in:
Brian 2018-10-29 19:38:27 -07:00 committed by GitHub
parent c508ca3f47
commit 680d0fcb87
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 13 deletions

View File

@ -1,7 +1,7 @@
# Burrow
A client/browser that accesses _gopherspace_. It is under current early stage development.
![Burrow browser](http://brianmevans.com/files/digger.png "Burrow v0.1.5 main window")
![Burrow browser](http://brianmevans.com/files/burrow_01.png "Burrow v0.1.8 main window")
## Gopher
[_Gopher_](https://en.wikipedia.org/wiki/Gopher_(protocol)) is a communications protocol that, in the early 90s, competed (briefly) with what became the world wide web. _Gopher_ serves up files and text based menus. As such, it is much lighter weight than HTML documents and the like served over http. Due to its text based nature it also has the benefit of being reliable in its visual output and style, and for being relatively accessible.
@ -12,14 +12,14 @@ The following is a list of current and future Burrow features:
- Tk based GUI
- Back button, move backwards in session history
- Forward button, move forward in session history
- Refresh button, will be replaced by a favorite button __(non-functional)__
- Ffavorite button adds current page to favorites __(non-functional)__
- Home, shows favorites and is a start page
- An address bar, on _ENTER_ submits a request for a _gopher_ page
- Settings button __(non-functional)__
- Settings button, brings up configuration menu __(non-functional)__
- A display area for the requested information
- Scroll bar
- A status bar to display various information
- Links to menus and files
- Links
- On hover, link destination shows in status bar
- On hover, link is underlined
- Links are colored differently from regular text _(configurable)_
@ -27,13 +27,14 @@ The following is a list of current and future Burrow features:
- On primary click, destination is loaded and new location replaces old location in address bar
- On primary click, link background changes to visually confirm click _(configurable)_
- Cursor is a pointer over links, while regular text is an I-beam cursor.
- Menus Pages and files
- Menus display correctly and quickly
- Text files display correctly and quickly
- Images files
- Menus, Pages, and Files
- Menus display clickable links
- Text files display in the viewport
- Image files display in the viewport
- Right click on image allows for download __(non-functional)__
- Sound files __(non-functional)__
- Binary files __(non-functional)__
- HTML files, will open in default browser __(non-functional)__
- HTML files, open in a new tab in the default web browser
- Interactive pages/search __(non-functional)__
- History
- Session based history for backward and forward navigation
@ -47,7 +48,7 @@ The following is a list of current and future Burrow features:
- Files/download settings
- Secondary click context menus for text manipulation & file saving __(non-functional)__
- Page saving for offline viewing __(non-functional)__
- Hotkey to view raw page source for menus __(non-functional)__
- Hotkey to view page source for menus __(non-functional)__
- Errors
- Error warnings to user __(non-functional)__
- Error page on bad/malformed request __(non-functional)__
@ -57,8 +58,8 @@ The following is a list of current and future Burrow features:
## Installation
Burrow requires python3 to be installed on the system prior to running.
Until some bundling/setup file creation occurs, you will also need to add:
Until some bundling/setup-file creation occurs, you will also need to add:
pip3 install pillow
@ -71,7 +72,7 @@ If you get a console error complaining about tkinter try the following (or equiv
## Distribution
Burrow's primary system target is linux. Once a version 1.0 is reached the plan is to distribute primarily through [Snapcraft](https://snapcraft.io/) packages.
Burrow's primary system target is debian based linux systems. Once a version 1.0 is reached the plan is to distribute via .DEB packages and possibly through snapcraft (if a workable bundle can be figured out).
Some version of windows executable may come along as well, depending on configurability of build tools (py2exe, freeze, etc) for windows executables and time.