Updated readme and added clean command

This commit is contained in:
sloumdrone 2019-01-21 19:38:13 -08:00
parent 0d07b8c95e
commit 59ee19882e
2 changed files with 29 additions and 6 deletions

View File

@ -4,7 +4,7 @@ Stubb is a text based gopher client that only displays and supports gophertypes:
In an effort to streamline the browsing experience for text only, gophermap rendering will not include lines with gophertypes that are not 0, 1, or i (text/display elements). Stubb supports bookmarks, file save, and session only history (cleared on quit).
Support for search is currently under consideration. I have not generally found Gopher search to be particularly useful. The lack of tagging and organization makes most search results from Veronica2 seem like playing the lottery. We'll see.
Search has been implemented with a default of Veronica2 as the search service.
The command bar lists the current tab number, out of how many total tabs. It also lists the current place in history (for the tab you are currently on).
@ -12,9 +12,9 @@ The command bar lists the current tab number, out of how many total tabs. It als
### Setup
Make sure your system has Lua 5.1 on it. I believe this application should work with 5.2 (so long as you get the appropriate dependencies), however, I believe the socket library is buggy for 5.3, so best to stay on an earlier version.
Stubb has been tested with Lua versions >= 5.1. I had been told that the socket library is buggy on 5.3, but have not experienced any problems myself. Most testing has been done with 5.1 and 5.2.
If you do not have luarocks package manager, get it and run: `luarocks install luasocket`
Luasocket is required. It can be acquired via luarocks with: `luarocks install luasocket`. You can also get it via [github](https://github.com/diegonehab/luasocket). Using luarocks is recommended as the easier option.
That should take care of dependencies. You just need to make sure that __stubb__ (found in this repo) is executable and you are good to go.
@ -22,7 +22,7 @@ That should take care of dependencies. You just need to make sure that __stubb__
### Versions
This repo contains two files: `stubb` and `stubb-lite`. The later has a simpler menu structure and lacks support for having multiple tabs open. The filesize and memory usage should be similar, but the navigation may involve fewer keypresses in the lite version.
This repo contains two files: `stubb` and `stubb-lite`. The later has a simpler menu structure and lacks support for having multiple tabs open. The filesize and memory usage should be similar, but the navigation may involve fewer keypresses in the lite version. The lite version is not under active development and is provided as a legacy item.
### Commands
@ -39,6 +39,17 @@ Stub responds to single key commands without requiring the user to press enter.
* (T)ab
* (U)rl
* (R)eload current url
* (P)ipe to:
* (R)eader
* (C)urrent
* (T)ab
* (C)urrent
* (L)ink
* (D)isk
* (C)urrent
* (L)ink
* (S)earch
* __Bookmarks/Tabs__
* (A)dd
@ -53,9 +64,9 @@ Stub responds to single key commands without requiring the user to press enter.
* (U)pdate bookmark title
* __System__
* (C)lean the screen
* (H)elp
* (Q)uit
* (S)ave current page
* (Q)uit Stubb
When a gophermap is loaded, links will be enumerated. Pressing (G) and then (L) will prompt you for what link you would like to follow. Links are always based on the most recently loaded url for your current tab.
@ -70,6 +81,12 @@ If Stubb's slim and light style is not fitting your needs, or you just want to c
- [Burrow](https://tildegit.org/sloum/burrow): My gui based browser with a wider featureset (primarily for *nix system)
- [VF-1](https://github.com/solderpunk/VF-1): A great/stable gopher client written by Solderpunk, who maintains one of the best gopher communities out there, [The People's Circumlunar Zaibatsu](gopher://zaibatsu.circumlunar.space:70/) (a part of [Circumlunar Space](http://circumlunar.space/)).
### Future
Currently, the big item under consideration is a user editable config file. The config would allow a user to change their search engine, default save path, toggle color output, change reader application, etc.

6
stubb
View File

@ -235,6 +235,7 @@ function mainloop()
elseif key == 'l' then list()
elseif key == 'd' then delete()
elseif key == 'g' then go_to()
elseif key == 'c' then clean_screen()
else print('Invalid entry') end
end
end
@ -306,6 +307,7 @@ function print_help()
(U)pdate bookmark title
<System>
(C)lean the screen
(H)elp
(Q)uit Stubb
@ -464,6 +466,10 @@ function go_to()
end
function clean_screen()
os.execute('clear')
end
--||__||--||__||--||__||--||__||--||__||--||__||--||__||--||