Skip to content

Latest commit

 

History

History
189 lines (123 loc) · 5.43 KB

README.md

File metadata and controls

189 lines (123 loc) · 5.43 KB

Contributors Forks Stargazers Issues MIT License


Logo

Ignition Git

JGit wrapper for Ignition.
Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

This project integrates basic git functionality through scripting directly into Inductive Automation's Ignition 8 platform.

Please note that this project is not associated with the Ignition or Inductive Automation team in any way.

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Installation

Download the latest release from https://github.com/jimender2/Ignition-Git/releases/latest

Development Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • JDK version 11 or later
  • Maven
  • IDE to edit the project with

Develeopment Installation

  1. Clone the repo
    git clone https://github.com/jimender2/Ignition-Git.git
  2. Build the module using mvn clean build and then signing the resulting file.
  3. Install module on the Ignition Gateway

(back to top)

Usage

Simple instructions coming soon.

For more examples, please refer to the [Documentation (Coming Soon)](Coming Soon)

(back to top)

Roadmap

  • [] Documentation
  • [] RPC function
  • [] More functions

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Jimender2 - jimender2 at jimender2.net

Project Link: https://github.com/jimender2/Ignition-Git

(back to top)

Acknowledgments

(back to top)