github.com/atrn/dcc@v0.0.0-20220806184050-4470d2553272/BUILDING.md (about)

     1  # Building dcc
     2  
     3  The repo contains everything required. A simple `go build` builds
     4  `dcc` and `go install` puts it in a user's (Go) _bin_ directory.
     5  
     6      $ go build
     7      $ go install
     8  
     9  The complete build of dcc uses [enums](http://github.com/atrn/enums)`
    10  to generate the runningmode,go file.
    11  
    12  ## enums
    13  
    14  `enums` is a `go generate`` tool that uses a Go-like lanauge to define
    15  C-like enumerated types. enums generates the Go code to implement the
    16  types. `dcc` uses `enums` to create the file `runningmode.go` file
    17  (from `runningmode.enum`).
    18  
    19  You can install `enums` via,
    20  
    21      $ go get github.com/atrn/enums
    22  
    23  Given that dcc only has a single enum using `enums` is a little
    24  gratutious but I use it elsewhere and its _natural_ to me.
    25  
    26  ## Complete Build
    27  
    28      $ go get github.com/atrn/enums
    29      $ go generate
    30      $ go build
    31      $ go install