Magma

Build Status Gem Version

Melts static video templates to produce dynamic, templated videos using melt and the MLT Framework.

Installation

  1. Install Ruby and MLT
  2. Run gem install magma_cli
  3. Run magma [arguments]

Installation (Dockerized)

  1. Run make
  2. Run bin/dmagma [arguments] (or just run docker run ... manually)

NOTE: for Linux hosts, the Docker daemon runs as the root user, so any files created will be owned by root. You can run chown afterwards to transfer ownership to your non-root user.

Usage

Run magma help.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the LGPL-2.1 License.

Code of Conduct

Everyone interacting in the magma project’s codebases, issue trackers, is expected to follow the code of conduct.