"Hey dol! merry dol! ring a dong dillo! Ring a dong! hop along! fal lal the willow! Tom Bom, jolly Tom, Tom Bombadillo!". Bombabillo is a gopher client for the terminal featuring vim-like key bindings and a "fullscreen terminal ui".
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
sloum 309d6244e1 Merge branch 'type-seven-bm-fix' of sloum/bombadillo into master 2 years ago
cmdparse Users can now check settings in the client and receive better messages 3 years ago
config improve error handling 3 years ago
cui Simplified method code 3 years ago
gopher Simplified gophertype fix for search response 2 years ago
.gitignore Gofmt all code, switch to canonical function naming, add a go.mod file for use with the latest go version 3 years ago
LICENSE add GPLv3 license. Closes #4 3 years ago
README.md Updates readme to include language about the newly included bombadillo-info file. 2 years ago
bombadillo-info Updates readme to include language about the newly included bombadillo-info file. 2 years ago
go.mod Gofmt all code, switch to canonical function naming, add a go.mod file for use with the latest go version 3 years ago
main.go Clarifying comment 3 years ago
notes.md Added focus shifting between windows redid how draws work 3 years ago

README.md

Bombadillo

Bombadillo is a modern Gopher client for the terminal, and functions as a pager/terminal UI. Bombadillo features vim-like keybindings, configurable settings, and a robust command selection. Bombadillo is under active development.

Getting Started

These instructions will get a copy of the project up and running on your local machine.

Prerequisites

If building from source, you will need to have Go version >= 1.11. Bombadillo uses the module system, so if using 1.11 you will need to have that feature enabled. If using a version > 1.11, you already have modules enabled.

Bombadillo does not use any outside dependencies beyond the Go standard library.

Installing

Assuming you have go installed, run the following:

git clone https://tildegit.org/sloum/bombadillo.git
cd bombadillo
go install

Once you have done that you should, assuming go install is set up to install to a place on your path, you should be able to run the following from anywhere on your system to use Bombadillo:

bombadillo

Troubleshooting

If you run bombadillo and get bombadillo: command not found, try running go build from within the cloned repo. Then try: ./bombadillo. If that works it means that Go does not install to your path. go build added an executable file to the repo directory. Move that file to somewhere on your path. I suggest /usr/local/bin on most systems, but that may be a matter of personal preference.

Downloading

If you would prefer to download a binary for your system, rather than build from source, please visit the Bombadillo downloads page. Don't see your OS/architecture? Bombadillo can be built for use with any POSIX compliant system that is supported as a target for the Go compiler (Linux, BSD, OS X, Plan 9). No testing has been done for Windows. The program will build, but will likely not work properly outside of the Linux subsystem. If you are a Windows user and would like to do some testing or get involved in development please reach out or open an issue.

Documentation

Bombadillo has documentation available in three places currently. The first is the Bombadillo homepage, which has lots of information about the program, links to places around Gopher, and documentation of the commands and configuration options.

Secondly, and possibly more importantly, documentation is available via Gopher from within Bombadillo. When a user launches Bombadillo for the first time, their homeurl is set to the help file. As such they will have access to all of the key bindings, commands, and configuration from the first run. A user can also type :? or :help at any time to return to the documentation. Remember that Bombadillo uses vim-like key bindings, so scroll with j and k to view the docs file.

Lastly, this repo contains a file bombadillo-info. This is a duplicate of the help file that is hosted over gopher mentioned above. Per user request it has been added to the repo so that pull requests can be created with updates to the documentation.

The longterm hope is to create an installer of some sort that will move bombadillo onto a users path (compiling if need be) and installing a man file (yet to be created) onto their system. There is also talk about being able to open local files and use bombadillo as a pager, which would enable linking in the included help file.

Contributing

Bombadillo development is largely handled by Sloum, with help from jboverf and some community input. If you would like to get involved, please reach out or submit an issue. At present the developers use the tildegit issues system to discuss new features, track bugs, and communicate with users about hopes and/or issues for/with the software.

License

This project is licensed under the GNU GPL version 3- see the LICENSE file for details.