30 lines
856 B
Markdown
30 lines
856 B
Markdown
# gitwarrior
|
|
|
|
Cli tool to sync git issues and milstones with taskwarrior tasks.
|
|
|
|
## Building
|
|
|
|
This project uses `make` to build. You can run `make` to build the application.
|
|
You can run `make run` to start the cli after building the application.
|
|
`make install` will require previledges to install the created binary and
|
|
documentation to the corresponding places. The variable `INSTALL_PATH` in the
|
|
[Makefile](Makefile) contains the directory used for the installation of the
|
|
application.
|
|
|
|
## Installation
|
|
|
|
Run the following commands after cloning the repository in the root directory of
|
|
your local copy:
|
|
|
|
```sh
|
|
make
|
|
sudo make install
|
|
```
|
|
|
|
## Dependencies
|
|
|
|
The goal should be to use to as least as possible external packages.
|
|
|
|
- [cobra - Modern CLI applications](https://github.com/spf13/cobra)
|
|
- [viper - Go configurations](https://github.com/spf13/viper)
|