https://github.com/vineyardbovines/golf

the faster way to init a project
https://github.com/vineyardbovines/golf

initializer project-initialization shell shell-script

Last synced: 1 day ago
JSON representation

the faster way to init a project

• Host: GitHub
• URL: https://github.com/vineyardbovines/golf
• Owner: vineyardbovines
• License: mit
• Created: 2018-06-21T20:40:24.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-12-15T11:50:00.000Z (11 months ago)
• Last Synced: 2024-10-16T09:30:04.157Z (about 1 month ago)
• Topics: initializer, project-initialization, shell, shell-script
• Language: Shell
• Size: 8.51 MB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# golf ⛳️

> the faster way to init a project

![demo](./demo.gif)

## requirements

- bash 4+

- dialog

- jq

macOS users can install all with homebrew

```bash

$ brew install bash dialog jq

```

## installation

**homebrew -- not working atm**

```bash

$ brew tap gretzky/formulae

$ brew install golf

```

**manually**

```bash

$ git clone https://github.com/gretzky/golf

$ make install

```

by default, it installs to `/usr/local`. you can change the prefix if you want.

```bash

$ make PREFIX=$WHATEVER install

```

you can also uninstall with `make uninstall`

## usage

```bash

$ golf

```

by default, golf creates your project directory and outputs a gitignore, editorconfig, license, readme, and optional github templates all based on your input.

**options**

`-d | --with-defaults`: will output a generic gitignore, editorconfig, README, and the MIT license

`-m | --minimal`: outputs only a gitignore and editorconfig

for help, run golf with the `-h | --help` flag, or `man golf`.

**looking for something nodejs specific? check out [golf.js](https://github.com/gretzky/golf.js)**

## license

[MIT](./LICENSE)