/cookiecutter-neovim-plugin

Cookiecutter template for Neovim plugin.

Primary LanguagePythonMIT LicenseMIT

cookiecutter-neovim-plugin

Cookiecutter template for Neovim plugin.

Build Status

Requirements

Cookiecutter (>=1.4.x) (https://github.com/audreyr/cookiecutter)

How to

You can create new project of Cookiecutter template as follows.

$ cookiecutter gh:FGtatsuro/cookiecutter-neovim-plugin
...
project_name [Name of generated plugin]: test-project
project_description [Description of generated plugin]: Test Project
year [2018]:
author [FGtatsuro]:
...
$ cd test-project
$ ls -1a
.
..
LICENSE
README.rst

You can overwrite default value of the field prompt asks with ~/.cookiecutterrc. It's better to overwrite 'author' field with your Github username.

$ cat ~/.cookiecutterrc
default_context:
    author: "FGtatsuro"

$ cookiecutter gh:FGtatsuro/cookiecutter-neovim-plugin
...
author [FGtatsuro]:
...