Skip to content

OpenC3/openc3-widget-template

Repository files navigation

OpenC3 Widget Template

Documentation

This plugin provides a template for creating OpenC3 Widgets in Vue

Getting Started

  1. Edit plugin.txt and change WIDGETTEMPLATE with the name of your widget
  2. Edit package.json and update the build line with the name of your widget and files
  3. Rename the .gemspec file to the name of your plugin
  4. Edit the .gemspec file fields: name, summary, description, authors, email, and homepage
  5. Update the LICENSE.txt file with your company name
  6. Build your widget in src
  7. Run: yarn
  8. Build your plugin with: rake build VERSION=1.0.0

Contributing

We encourage you to contribute to OpenC3!

Contributing is easy.

  1. Fork the project
  2. Create a feature branch
  3. Make your changes
  4. Submit a pull request

Before any contributions can be incorporated we do require all contributors to agree to a Contributor License Agreement

This protects both you and us and you retain full rights to any code you write.

License

This OpenC3 plugin is released under the MIT License. See LICENSE.txt