Skip to content
This repository has been archived by the owner on May 1, 2024. It is now read-only.

Latest commit

 

History

History
86 lines (57 loc) · 3.65 KB

README.md

File metadata and controls

86 lines (57 loc) · 3.65 KB

incendium-project

GitHub contributors GitHub total downloads GitHub last commit (project) GitHub release (latest) time tracker Sourcery Code style: black Imports: isort Imports: flake8 Imports: pydocstyle linting: pylint Join us on GitHub discussions

(/inˈken.di.um/)

noun.

  1. A fire, inferno, conflagration; heat; torch.
  2. (heat of) passion, vehemence

📦 Package that extends and wraps some functions from Ignition's Scripting API.

For more information, please refer to the Wiki.

Installing incendium as a Project on your Gateway

To install incendium on your Gateway follow these steps:

  1. Download incendium.x.x.x.zip from the latest release or from Ignition Exchange
  2. Browse to your Ignition Gateway (version 8.0+)
  3. Go to Config > Projects and click on Import project...
  4. Click on Choose File and select the downloaded ZIP file
  5. Enter incendium as the Project Name
    • If you're replacing a previous version, make sure to check Allow Overwrite
  6. Click on Import

Alternatively you could follow the instructions for cloning the project branch directly into $IGNITION_DIR/data/projects found here.

Cloning this repo

If you would like to clone this repo to get the latest version directly under $IGNITION_DIR/data/projects, follow these steps:

  1. Open your Terminal

  2. Switch to $IGNITION_DIR/data/projects

  3. Run any of the following commands

    • HTTPS

      git clone https://github.com/thecesrom/incendium-project.git incendium
    • SSH

      git clone [email protected]:thecesrom/incendium-project.git incendium
    • GitHub CLI

      gh repo clone thecesrom/incendium-project incendium
  4. And git pull to get the latest changes

Contributing

See CONTRIBUTING.md.

Contributors

Thanks to everyone who has contributed to this project.

Up-to-date list of contributors can be found here.

License

See the LICENSE.

Code of conduct

See CODE_OF_CONDUCT.md.