yves-biener/gitwarrior
Archived
1
0
Fork 0
Code Pull Requests Releases Activity

add: man page and installation make step

Browse Source
This commit is contained in:
Yves Biener
2023-10-26 17:27:43 +02:00
parent 973338baff
commit 896066f8a7
4 changed files with 94 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -4,7 +4,22 @@ 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.
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