Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
gretzky committed Jun 21, 2018
1 parent a8e3cce commit 07153dc
Show file tree
Hide file tree
Showing 28 changed files with 210 additions and 882 deletions.
6 changes: 2 additions & 4 deletions poop2/.gitignore → .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

# Created by https://www.gitignore.io/api/macos,,,
# Created by https://www.gitignore.io/api/macos

### macOS ###
*.DS_Store
Expand Down Expand Up @@ -28,7 +28,5 @@ Network Trash Folder
Temporary Items
.apdisk

#!! ERROR: is undefined. Use list command to see defined gitignore types !!#


# End of https://www.gitignore.io/api/macos,,,
# End of https://www.gitignore.io/api/macos
9 changes: 9 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
The MIT License

Copyright (c) 2018 Sara Federico

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
26 changes: 26 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
SCRIPT = golf.sh
MANPAGE = $(SCRIPT).6

PREFIX = /usr/local
DESTDIR =
INSTDIR = $(DESTDIR)$(PREFIX)
INSTBIN = $(INSTDIR)/bin
INSTMAN = $(INSTDIR)/share/man/man6

all:
@echo did nothing. try targets: install, or uninstall
.PHONY: all

install:
mkdir -p $(INSTDIR)
mkdir -p $(INSTBIN)
mkdir -p $(INSTMAN)

install -m 0755 $(SCRIPT) $(INSTBIN)
install -m 0644 $(MANPAGE) $(INSTMAN)
.PHONY: install

uninstall:
$(RM) $(INSTBIN)/$(SCRIPT)
$(RM) $(INSTMAN)$(MANPAGE)
.PHONY: uninstall
63 changes: 63 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# golf

> the faster way to init a project
## requirements

- bash 4+
- dialog
- jq

macOS users can install all with homebrew

```bash
$ brew install bash dialog jq
```

## installation

**homebrew**

**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

golf is a dialog program that walks you through all the steps you need to init a new dev project.

it will:

- create a new named project directory
- generate a basic README
- configure a .gitignore
- configure an .editorconfig
- generate a license file

all based on your inputs.

optional:

- generates a changelog
- generates github templates (bugs, pull request, etc.)

for help:

```bash
man golf.sh
```

# license

[MIT](./LICENSE)
1 change: 0 additions & 1 deletion bin/git/HEAD

This file was deleted.

7 changes: 0 additions & 7 deletions bin/git/config

This file was deleted.

1 change: 0 additions & 1 deletion bin/git/description

This file was deleted.

15 changes: 0 additions & 15 deletions bin/git/hooks/applypatch-msg.sample

This file was deleted.

24 changes: 0 additions & 24 deletions bin/git/hooks/commit-msg.sample

This file was deleted.

114 changes: 0 additions & 114 deletions bin/git/hooks/fsmonitor-watchman.sample

This file was deleted.

8 changes: 0 additions & 8 deletions bin/git/hooks/post-update.sample

This file was deleted.

14 changes: 0 additions & 14 deletions bin/git/hooks/pre-applypatch.sample

This file was deleted.

49 changes: 0 additions & 49 deletions bin/git/hooks/pre-commit.sample

This file was deleted.

Loading

0 comments on commit 07153dc

Please sign in to comment.