updated readme and documentation

This commit is contained in:
James Tomasino 2018-04-11 22:34:27 -04:00
parent bc050454ff
commit 3d22e5d275
3 changed files with 2 additions and 24 deletions

View File

@ -4,12 +4,6 @@
## Installation
### Dependencies
#### Required
* bash 4+
### Install
`sudo make install`
@ -33,7 +27,6 @@ burrow rss # generate a RSS feed of phlog entries
burrow create-config # generate a default config file
burrow edit-config # open your config file for editing
burrow update-git # pull latest git repo for gopher dir, if exists
burrow update-burrow # update git repo or pull latest version from github
```
- `create-config` will auto-generate a configuration file at
@ -63,11 +56,6 @@ automatically generated by using the config option `config_phlog_autorss`.
- `update-git` will silently attempt to update a git repository at the location
of your gopher hole. It is appropriate for use by a cron job.
- `update-burrow` will attempt to pull the latest version of burrow from git if
your local folder is a git repository. If not, it will attempt to update each
file in the burrow directory with the same named file in the master branch of
the git repository for burrow on Github.
_`man burrow` or `burrow -h` for more information._
## Config

2
burrow
View File

@ -1,6 +1,6 @@
#!/bin/sh
version="v1.4.1"
version="v1.5.0"
configfiles="$HOME/.config/burrow/config $HOME/.config/burrow $HOME/.burrow"

View File

@ -1,4 +1,4 @@
.TH BURROW 1 "9 Apr 2018" "version 1.4.1"
.TH BURROW 1 "11 Apr 2018" "version 1.5.0"
.SH NAME
burrow \- a helper for building and managing a gopher hole
.SH SYNOPSIS
@ -52,16 +52,6 @@ of your gopher hole. It is appropriate for use by a cron job.
.TP
.B git-pull
which is useful for crons.
.TP
.B update-burrow
Burrow will attempt to auto-update. If the local folder where burrow is
installed is a git repository, burrow will pull the latest commit from the
remote branch. If the local directory is not a git remote, burrow will attempt
to update local files with their counterpart on the Github remote repository.
The local directory will only attempt to update files in this way which are
named
.I burrow
or some variation of that name.
.SH OPTIONS
.TP
.B -v