README

generator-gitignore

Quickly create your .gitignore file from the most widely used configurations. A generator for Yeoman.

To install generator-gitignore from npm, run:

$ npm install -g generator-gitignore

Finally, initiate the generator:

$ yo gitignore

Features

[✓] Automatically downloads from https://github.com/github/gitignore and insert into .gitignore file.
[✓] Search https://github.com/github/gitignore
[✗] Suggests common configurations: Linux, Mac OSX, Windows, Vim, and more.

Example

$ yo gitignore

     _-----_
    |       |
    |--(o)--|   .--------------------------.
   `---------´  |    Welcome to Yeoman,    |
    ( _´U`_ )   |   ladies and gentlemen!  |
    /___A___\   '__________________________'
     |  ~  |
   __'.___.'__
 ´   `  |° ´ Y `


[?] Choose a GitIgnore file: 
  Global/VirtualEnv.gitignore 
  Global/Windows.gitignore 
  Global/XilinxISE.gitignore 
❯ Global/vim.gitignore 
  Global/webMethods.gitignore 
  Go.gitignore 
  Gradle.gitignore 
(Move up and down to reveal more choices)

[?] Choose a GitIgnore file: Global/vim.gitignore
 conflict .gitignore
[?] Overwrite .gitignore? overwrite
    force .gitignore


I'm all done. Running bower install & npm install for you to install the required dependencies. If this fails, try running the command yourself.

Getting Started

What is Yeoman?

Trick question. It's not a thing. It's this guy:

Basically, he wears a top hat, lives in your computer, and waits for you to tell him what kind of application you wish to create.

Not every new computer comes with a Yeoman pre-installed. He lives in the npm package repository. You only have to ask for him once, then he packs up and moves into your hard drive. Make sure you clean up, he likes new and shiny things.

$ npm install -g yo

Yeoman Generators

Yeoman travels light. He didn't pack any generators when he moved in. You can think of a generator like a plug-in. You get to choose what type of application you wish to create, such as a Backbone application or even a Chrome extension.

To install generator-gitignore from npm, run:

$ npm install -g generator-gitignore

Finally, initiate the generator:

$ yo gitignore

Getting To Know Yeoman

Yeoman has a heart of gold. He's a person with feelings and opinions, but he's very easy to work with. If you think he's too opinionated, he can be easily convinced.

If you'd like to get to know Yeoman better and meet some of his friends, Grunt and Bower, check out the complete Getting Started Guide.

License

MIT License

Usage no npm install needed!