NAME

App::mbxilinx - Module to invoke the Module::Xilinx::Build class with a YAML file and generate Build

VERSION

0.13

SYNOPSIS

use App::mbxilinx;
App::mbxilinx->process('build.yml');

FUNCTIONS

process(YML)

The process() function takes only 1 argument and that is the YAML filename to load.

The invocation of the function is as follows:

App::mbxilinx->process('myfile.yml');

THE YAML FILE

The YAML file required here may be titled build.yml or could be anything else. By default if you just run mbxilinx without any arguments it will look for build.yml in the current directory or fail or if you have a use case where you may need to use it from another module, you could use App::mbxilinx instead.

A sample build.yml is present in the share/example directory in the source code which we shall reproduce here

---
dist_name: dflipflops
dist_version: '0.01'
dist_author: 'Vikas N Kumar <vikas@cpan.org>'
dist_abstract: 'This is a test'
proj_params:
    family: spartan3a
    device: xc3s700a
    package: fg484
    speed: -4
    language: VHDL

The mbxilinx program using the App::mbxilinx module just parses the input YAML file and then calls Module::Build::Xilinx to create the Build script for use by the user as given in the Module::Build::Xilinx documentation.

SEE ALSO

Module::Build::Xilinx, mbxilinx

AUTHOR

Vikas Kumar, <vikas@cpan.org>

CONTACT

Find me on IRC: #hardware on irc://irc.perl.org as user name vicash.

COPYRIGHT AND LICENSE

Copyright (C) 2014 by Vikas Kumar

This library is under the MIT license. Please refer the LICENSE file for more information provided with the distribution.