make bpkg friendly

pull/42/head
Joseph Werle 7 years ago
parent cfaca1fa10
commit 31233788e3

@ -8,6 +8,31 @@ That's really up to you, but here are some examples:
* **document files**: if you use an editor that does not have built-in git support (or maybe if you don't like the git support it has), you can use gitwatch to automatically commit your files when you save them, or combine it with the editor's auto-save feature to fully automatically and regularly track your changes
* *more stuff!* If you have any other uses, or can think of ones, please let us know, and we can add them to this list!
## Installation
`gitwatch` can be installed in various ways.
### From Source
`gitwatch` can be installed from source by simply cloning the repository
and putting the shell script into your `$PATH`. The commands below will
do that for you if `/usr/local/bin` is in your `$PATH`. You may need to
invoke `install` with `sudo`.
```sh
$ git clone https://github.com/nevik/gitwatch.git
$ cd gitwatch
$ [sudo] install -b gitwatch.sh /usr/local/bin/gitwatch
```
### bpkg
`gitwatch` can be installed with [bpkg](https://github.com/bpkg/bpkg). Make
sure you have [bpkg](https://github.com/bpkg/bpkg) installed before
running the command below. You may need to invoke `bpkg` with `sudo`
when using the `-g` flag.
```sh
$ [sudo] bpkg install -g nevik/gitwatch
```
## Requirements
To run this script, you must have installed and globally available:
* `git` ( [git/git](https://github.com/git/git) | http://www.git-scm.com )

@ -0,0 +1,8 @@
{
"name": "gitwatch",
"version": "0.0.1",
"description": "A script to watch a file or folder and automatically commit changes to a Git repo",
"global": "1",
"install": "install -b gitwatch.sh ${PREFIX:-/usr/local}/bin/gitwatch",
"scripts": [ "gitwatch.sh" ]
}
Loading…
Cancel
Save