This project is a foreign-function interface wrapper of the [Augeas libfa Finite Automata library](http://augeas.net/libfa/) for the [Rust](http://www.rust-lang.org) programming language.

[![](http://meritbadge.herokuapp.com/fa)](https://crates.io/crates/fa)

## Installation
This project uses the following software:

 *  [Rust](http://www.rust-lang.org)
 *  [Cargo](http://crates.io)
 *  [Augeas libfa Finite Automata library](http://augeas.net/libfa/)
 *  pkg-config

On Mac systems, it is recommended to install Rust and Cargo using [Homebrew](http://brew.sh)'s `rust` formula:

<pre>
brew install rust
</pre>

On other platforms, see https://www.rust-lang.org/downloads.html

To install libfa:

 *  Mac with Homebrew:
    <pre>
    brew install augeas
    </pre>

 *  Debian/Ubuntu:
    <pre>
    sudo apt-get install libaugeas-dev
    </pre>

With the dependencies installed, the `fa` crate is built by running:

<pre>
cargo build
</pre>

To generate the HTML documentation, run:

<pre>
cargo doc
</pre>

## License
The wrapper source code is licensed under the [GNU Lesser General Public License](http://www.gnu.org/licenses/lgpl.html) as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.