### ----------------------------------------------------
### -- XDG::BaseDirectory
### -- Licenses: Artistic-2.0
### -- Authors: Jonathan Stowe <jns+git@gellyfish.co.uk
### -- File: README.md
### ----------------------------------------------------
# XDG::BaseDirectory

Raku access to path information provided by the xdg base directory specfication http://www.freedesktop.org/wiki/Specifications/basedir-spec/

![Build Status](https://github.com/jonathanstowe/XDG-BaseDirectory/workflows/CI/badge.svg)

## Synopsis

```raku

    use XDG::BaseDirectory;

    my $bd = XDG::BaseDirectory.new

    for $bd.load-config-paths('mydomain.org', 'MyProg', 'Options') -> $d {
        say $d;
    }

    # Directories can be made available as terms as well
    use XDG::BaseDirectory :terms;

    say config-home;

```

## Description

This is loosely based on the interface of python module pyxdg. But
due to the differences between Python and Raku it may do some things
differently.

It provides a set of facilities for discovering the location of the
configuration and data of applications.

I split this out from the XDG module as it has more general usefulness
and no external dependencies.

## Installation

Assuming you have a working Rakudo installation with *zef* installed you can install from a copy of the source directory:

     zef install .

or remotely:

     zef install XDG::BaseDirectory 

## Support

Suggestions/patches are welcomed via github at:

https://github.com/jonathanstowe/XDG-BaseDirectory/issues

I'm not able to test on a wide variety of platforms so any help there would be appreciated.

## Licence

This module is Free Software please see the [LICENCE](LICENCE) file in the distribution for the exact terms.

© Jonathan Stowe 2015-2021


