gopherhole tool

Go to file

James Tomasino b9535f4f0f add basic man page		2018-01-20 01:32:19 -05:00
LICENSE	add license	2018-01-20 00:19:32 -05:00
Makefile	add make install & uninstall	2018-01-20 00:19:29 -05:00
README.md	add readme basics	2018-01-20 01:00:51 -05:00
burrow	add template for burrow source	2018-01-20 01:30:36 -05:00
burrow.1	add basic man page	2018-01-20 01:32:19 -05:00

README.md

burrow

burrow is a helper for building and managing a gopher hole (in development).

Installation

Requirements

make
bash 4+

Install

make install

Uninstall

make uninstall

Usage

man burrow                # see full instructions
burrow -h                 # show help

burrow -p <title>         # create new phlog post
burrow -r <recipe_title>  # add new recipe to box

Config

burrow supports two ways to define config.

$HOME/.config/burrow
$HOME/.burrow

In either location, the following options are available and show their defaults:

location_gopher = "$HOME/gopher"
location_phlog = "$HOME/gopher/phlog"
location_recipebox = "$HOME/gopher/recipebox"

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

GPL3