github.com/gsquire/gb@v0.4.4-0.20161112235727-3982dc872064/README.md (about)

     1  # gb
     2  
     3  ### Build status
     4  Unix:
     5  [![travis-cs status](https://travis-ci.org/constabulary/gb.svg "travis-ci status")](https://travis-ci.org/constabulary/gb)
     6  
     7  Windows:
     8  [![Build status](https://ci.appveyor.com/api/projects/status/rjttg1agmp2sra3h/branch/master?svg=true)](https://ci.appveyor.com/project/davecheney/gb/branch/master)
     9  
    10  `gb` is a proof of concept replacement build tool for the [Go programming language](https://golang.org).
    11  
    12  I gave a talk about `gb` and the rational for its creation at GDG Berlin in April 2015, [video](https://www.youtube.com/watch?v=c3dW80eO88I) and [slides](http://go-talks.appspot.com/github.com/davecheney/presentations/reproducible-builds.slide#1).
    13  
    14  ## Project based
    15  
    16  `gb` operates on the concept of a project. A gb project is a workspace for all the Go code that is required to build your project.
    17  
    18  A gb project is a folder on disk that contains a subdirectory named <code>src/</code>. That's it, no environment variables to set. For the rest of this document we'll refer to your <code>gb</code> project as <code>$PROJECT</code>.
    19  
    20  You can create as many projects as you like and move between them simply by changing directories.
    21  
    22  ## Installation
    23  
    24      go get github.com/constabulary/gb/...
    25  
    26  ## Read more
    27  
    28  gb has its own site, [getgb.io](http://getgb.io/), head over there for more information.
    29  
    30  ## Contributing
    31  
    32  ### Contribution guidelines
    33  
    34  We welcome pull requests, bug fixes and issue reports.
    35  
    36  Before proposing a large change, please discuss your change by raising an issue.
    37  
    38  ### Road map
    39  
    40  #### Completed
    41  
    42  - [Cross Compilation](https://github.com/constabulary/gb/milestones/cross-compilation)
    43  - Tag handling, unify -tags, ENVVARS and GOOS/GOARCH into a single format for binary names and pkg cache
    44  - gb test improvements, test output, test flag handling
    45  - [Race detector support](https://github.com/constabulary/gb/issues/96)
    46  
    47  #### Todo
    48  
    49  - 0.4 series: gb vendor updates and bug fixes
    50  - 0.5 series: new package resolver (replace go/build)
    51  
    52  ### Big ticket items 
    53  
    54  Big ticket items that are not on the road map yet
    55  
    56  - Package BuildID support (make stale detection work like the Go 1.5)
    57  - `gccgo` toolchain support.