github.com/rumpl/mod@v1.1.0/README.md (about)

     1  # mod
     2  
     3  ![ci](https://github.com/rumpl/mod/workflows/ci/badge.svg)
     4  [![codecov.io](https://codecov.io/github/rumpl/mod/coverage.svg?branch=master)](https://codecov.io/github/rumpl/mod?branch=master)
     5  
     6  A better `go mod init`.
     7  
     8  This little tool will help you initialize a go project with go modules. This is what it does:
     9  
    10  * initializes go with modules
    11  * creates a simple Makefile
    12  * creates a "Hello World" main.go file
    13  * creates a README file
    14  * initializes a git repository
    15  
    16  ## Intallation
    17  
    18  ```
    19  go get -u github.com/rumpl/mod
    20  ```
    21  
    22  ## Usage
    23  
    24  ```
    25  $ mod init awesome-project
    26  All done, happy hacking!
    27  
    28  $ ls -l awesome-project
    29  total 32
    30  -rw-r--r--  1 djordjelukic  staff  41 May 20 20:38 Makefile
    31  -rw-r--r--  1 djordjelukic  staff   7 May 20 20:38 README.md
    32  -rw-r--r--  1 djordjelukic  staff  38 May 20 20:38 go.mod
    33  -rw-r--r--  1 djordjelukic  staff  72 May 20 20:38 main.go
    34  ```
    35  
    36  ## License
    37  
    38  [MIT](https://rumpl.mit-license.org)