Update README.md

This commit is contained in:
Brian 2018-11-03 10:49:05 -07:00 committed by GitHub
parent 3615d47282
commit 497b7e4163
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 22 deletions

View File

@ -9,24 +9,18 @@ A client/browser that accesses _gopherspace_. It is under current early stage de
## Browser Features
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
- 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
- Graphical User Interface
- Back/Forward buttons, move about in session history
- Favorite button adds current page to favorites
- Home, shows favorites and is a start page _(configurable)_
- Address bar, on _ENTER_ submits a request for a _gopher_ page
- Settings button, brings up configuration menu __(non-functional)__
- A display area for the requested information
- Scroll bar
- Main window, displays request data/pages/files
- Vertical scroll bar
- Auto hiding of scroll bars __(non-functional)__
- A status bar to display various information
- Links
- On hover, link destination shows in status bar
- On hover, link is underlined
- Links are colored differently from regular text _(configurable)_
- Link type appears next to link in noticeable coloring _(configurable)_
- 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.
- Links in menu pages behave similar to http style hyperlinks
- Menus, Pages, and Files
- Menus display clickable links
- Text files display in the viewport
@ -35,24 +29,29 @@ The following is a list of current and future Burrow features:
- Sound files __(non-functional)__
- Binary files __(non-functional)__
- HTML files, open in a new tab in the default web browser
- Interactive pages/search __(non-functional)__
- Interactive pages/search display a search dialog and return a menu on send
- History
- Session based history for backward and forward navigation
- Persistent favorites __(non-functional)__
- Persistent favorites
- Record of last URL visited
- Suggestions on URL entry based on persistent history __(non-functional)__
- Application settings and menus
- Settings menu __(non-functional)__
- Color themes
- Icon themes
- History settings
- Files/download settings
- Toggle load into home vs. last visited
- Secondary click context menus for text manipulation & file saving __(non-functional)__
- Page saving for offline viewing __(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)__
- Error display for type 3 server response __(non-functional)__
- Error warnings to user _(semi-functional)_
- Error page on bad/malformed request _(semi-functional)_
- Error display for type 3 server response _(semi-functional)_
## Installation
@ -79,4 +78,4 @@ Some version of windows executable may come along as well, depending on configur
## Contribute
To contribute, please branch off of `develop` and then submit a pull request into `develop` with any changes. As the project grows I will likely add wiki, issues, etc as the need arises and more people get involved.
To contribute, please branch off of `develop` and then submit a pull request into `develop` with any changes. As the project grows I will likely add wiki, issues, project, etc as the need arises and more people get involved.