github.com/grantbow/fit@v0.7.1-0.20220916164603-1f7c88ac81e6/INSTALL.md (about)

     1  # fit
     2  filesystem issue tracker: manages plain text issues with git or hg
     3  
     4  **TOC:**
     5  
     6  <!-- toc -->
     7  
     8  - [Prerequisites](#prerequisites)
     9  - [Installation](#installation)
    10  
    11  <!-- tocstop -->
    12  
    13  ## Prerequisites
    14  
    15  git or hg (mercurial)
    16  
    17  golang
    18  
    19  linux, mac or windows OS.
    20  
    21  ## Installation
    22  
    23  First [install go](https://go.dev/doc/install) completely.
    24  
    25  make sure you
    26  have `go/bin` (or equivalent) for golang and `$HOME/go/bin` for installed binaries in your path.
    27  
    28  `GOPATH` should be set to something like `$HOME/go`.
    29  
    30  Install the latest version of fit with:
    31  
    32  `go install github.com/grantbow/fit@latest`
    33  
    34  If that does not work in one command then:
    35  ```
    36      $ mkdir -p $GOPATH/src/github.com/grantbow/fit
    37      $ git clone https://github.com/grantbow/fit $GOPATH/src/github.com/grantbow/fit
    38      $ cd $GOPATH/src/github.com/grantbow/fit/cmd/fit 
    39        # that's the fit/cmd/fit dir
    40      $ go install
    41  ```
    42  
    43  This will create the binary `$GOPATH/src/github.com/grantbow/fit/cmd/fit/fit(.exe)`
    44  and move it to `$GOPATH/bin/fit(.exe)`
    45  
    46  The environment variable set using `export GO111MODULE=on` changed how old
    47  golang versions work by enabling golang 1.11+ module support required by fit.
    48  The defaults in golang 1.13 and 1.14 and 1.15 were still "auto".
    49  The defaults in golang 1.16 and above are "on" so this setup is no longer required.
    50  
    51  You can use fit directly or use fit as a git subcommand like `git fit`.
    52  You can quickly add the alias to your .gitconfig:
    53  
    54  ```
    55   git config --global alias.fit \!/home/<user>/go/bin/fit`  
    56   git config --global alias.issue \!/home/<user>/go/bin/fit`  
    57   git config --global alias.bug \!/home/<user>/go/bin/fit`  
    58  ```
    59  
    60  Note: cygwin users use !/cygdrive/c/Users/\<user\>/go/bin/fit.exe
    61  
    62  This will add to your $HOME/.gitconfig or you can edit it manually:
    63  
    64  ```
    65  [alias]  
    66      fit = !/home/<user>/go/bin/fit
    67      issue = !/home/<user>/go/bin/fit
    68      bug = !/home/<user>/go/bin/fit
    69  ```
    70  
    71  This [chapter about git aliases](https://git-scm.com/book/en/v2/Git-Basics-Git-Aliases) describes how
    72  to set them up very well. It is part of the Pro Git book available for free
    73  online. 
    74  
    75  Your system is just the beginning, not the end. Much has been written about
    76  how to use and setup systems to track or manage issues, software bugs, trouble
    77  tickets, support tickets, incident tickets or requests. See the docs/FAQ.md
    78