Contents

# Xolti

> Tool assisting developers to manage license headers in source files, powered by Ruby.

[![Build Status](https://secure.travis-ci.org/RemiEven/xolti.svg?branch=master)](http://travis-ci.org/RemiEven/xolti)
[![License](https://img.shields.io/badge/license-GPL3-19c6ff.svg)](http://www.gnu.org/licenses/gpl-3.0.en.html)

## Purpose

If you ever had to manage the license of a project, you probably know how much a burden this task can become, especially if you try to keep it accurate !

Xolti is a piece of software aiming to assist the management of license-related information in a project. Its main functionality is to add and maintain license headers at the top of source files.

## Installation

Xolti is available on [RubyGems.org](https://rubygems.org/gems/xolti), so installing it is fairly easy:

```bash
gem install xolti
```

Once the installation completes, Xolti is added to your `$PATH`, so you can access it from everywhere.

> Please note that xolti is still in developer preview.

#### Requirements

Xolti requires Ruby to be installed in order to properly work. It has been tested with Ruby >= 2.1, but probably works with older versions too. In addition, Xolti requires `thor`, as stated in the `Gemfile`.

## Usage

Xolti provides a set of commands, such as :

###### I want to add a header to a file named `awesome.txt` :

```
xolti add awesome.txt
```

###### I want to check that `awesome.txt` has a correct header :

```
xolti check awesome.txt
```

###### I want to delete the header of `awesome.txt` :

```
xolti delete awesome.txt
```

###### I want to get a list of all files missing correct headers :

```
xolti add list_missing
```

###### I want to init a `xolti.yml` file :

```
xolti init
```

`xolti.yml` files are used by Xolti to get the information it needs (such as the license you picked or the project's name) in order to work.

## License

Xolti is a piece of free software licensed under the terms of the GNU-GPL3.

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
xolti-0.1.0	readme.md