mirror of https://github.com/bpkg/bpkg synced 2024-11-09 19:10:24 +00:00

History

Chris Carpita 5ad5fc9318 Improvements to bpkg init - Generate README.md file with description and install directions pre-filled - Generate $NAME.sh file with boilerplate, including source-check, usage, - argument processing, and version print. - Nice default for package.json "install" field - Initialize git repo if one does not exist - Fix issue with prompt where delete key erased prompt, by using `read -p`		2014-10-10 13:39:08 -04:00
..
init.sh	Improvements to bpkg init	2014-10-10 13:39:08 -04:00
LICENSE.md	Add bpkg-init script	2014-05-29 11:42:41 -04:00
Makefile	Add bpkg-init script	2014-05-29 11:42:41 -04:00
package.json	Add bpkg-init script	2014-05-29 11:42:41 -04:00
README.md	Add bpkg-init script	2014-05-29 11:42:41 -04:00

README.md

bpkg-init

Interactively generate a package.json for your bpkg. Code, format, and instructions based heavily on jwerle's clib-init.

install

With bpkg:

$ bpkg install benkogan/bpkg-init

From source:

$ git clone git@github.com:benkogan/bpkg-init.git /tmp/bpkg-init
$ cd /tmp/bpkg-init
$ make install

usage

Simply invoke bpkg init and you wil be prompted with a series of questions about the generation of your package.json. Most options have sane defaults.

This will walk you through initializing the bpkg package.json file. It will prompt you for the bare minimum that is needed and provide defaults.

See github.com/bpkg/bpkg for more information on defining the bpkg package.json file.

You can press ^C anytime to quit this prompt. The package.json file will only be written upon completion.

$ bpkg init

This will walk you through initializing the bpkg `package.json` file.
It will prompt you for the bare minimum that is needed and provide
defaults.

See github.com/bpkg/bpkg for more information on defining the bpkg
`package.json` file.

You can press ^C anytime to quit this prompt. The `package.json` file
will only be written upon completion.

name: (bpkg-init)

...

license

MIT