   ____                           
  |  _ \ __ _ _ __ ___  ___   _ _ 
  | |_) / _` | '__/ __|/ _ \ (_|_)
  |  __/ (_| | |  \__ \  __/  _ _ 
  |_|   \__,_|_|  |___/\___| (_|_)
                                  
    ____ _ _   _                            
   / ___(_) |_(_) __ _ _ __   ___  _ __ ___ 
  | |  _| | __| |/ _` | '_ \ / _ \| '__/ _ \
  | |_| | | |_| | (_| | | | | (_) | | |  __/
   \____|_|\__|_|\__, |_| |_|\___/|_|  \___|
                 |___/                      


This is the README for Parse::Gitignore version 1.0.

Parse::Gitignore is a "module" for the Perl computer programming language,
a library of computer code to install on a computer.  This document
contains four sections:

1. About - what the module does

2. Documentation - how to learn more about the module

3. Installation - how to install this module on a computer

4. Help - what to do if you get stuck

-----------------------------------------------------------------------------

1. ABOUT

Parse::Gitignore - parse .gitignore files

Parse a .gitignore file and check whether a file matches it.

-----------------------------------------------------------------------------

2. DOCUMENTATION

You can read the documentation for the module online at the following
website:

    * http://metacpan.org/release/Parse-Gitignore

(This link goes to the latest version of the module.)

After installing the module, you can read the documentation on your
computer using

    perldoc Parse::Gitignore

-----------------------------------------------------------------------------

3. INSTALLATION

This module requires Perl version 5.6.1 or later.

To install the module from CPAN, use

    cpan Parse::Gitignore

If you have the App::cpanminus installer, you may prefer

    cpanm Parse::Gitignore

To install the module from the source file, Parse-Gitignore-1.0.tar.gz,
follow this sequence of commands:

    tar xfz Parse-Gitignore-1.0.tar.gz
    cd Parse-Gitignore-1.0
    perl Makefile.PL
    make
    make install

If you want to test the module before installing it, use "make test" after
"make" and before "make install".

-----------------------------------------------------------------------------

4. HELP

To get help with the module, you can email the author, Ben Bullock, at
<benkasminbullock@gmail.com>. If you think there is a problem in the
module, you can report a bug at 

<https://github.com/benkasminbullock/parse-gitignore/issues>,

or if you want to alter the source code of Parse::Gitignore, try the public
repository on github at 

<https://github.com/benkasminbullock/parse-gitignore>. 

-----------------------------------------------------------------------------

This README was written on Tue Nov 12 06:24:05 2024.

-----------------------------------------------------------------------------
