Skip to content

Latest commit

 

History

History
51 lines (32 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

51 lines (32 loc) · 2.6 KB
Raw

Contributing

Thank you for considering to contribute to StableView!

When contributing to this repository, please first discuss the change you wish to make via discuss, issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Development environment setup

To set up a development environment, please follow these steps:

  1. Install Rust.

  2. Clone the repo

    git clone https://github.com/shubhamai/StableView

  3. Install opencv-rust on your system.

  4. Run cargo run to run the application without any optimizations. To run the application fully optimized, add --release to the command, ie. cargo run --release

  5. To build the .msi installer for windows -

    1. Install WiX Toolset v3.14.1.
    2. Install cargo-wix.
    3. Run cargo wix. A new folder will be created in target folder containing the .msi file.

Apple Silicon

To build stableview on apple silicon

  1. Download onnxruntime-osx-arm64-1.18.0.tgz from ONNX Runtime v1.18.0 and unzip it to assets/onnx_osx folder.

sudo ORT_LIB_LOCATION=./assets/onnx_osx ORT_STRATEGY=system DYLD_FALLBACK_LIBRARY_PATH=./assets/onnx_osx/lib cargo run --release

Issues and feature requests

You've found a bug in the source code, a mistake in the wiki or maybe you'd like a new feature? Take a look at GitHub Discussions to see if it's already being discussed. You can help us by submitting an issue on GitHub. Before you create an issue, make sure to search the issue archive, your issue may have already been addressed!

How to submit a Pull Request

  1. Search our repository for open or closed Pull Requests that relate to your submission. You don't want to duplicate effort.
  2. Fork the project
  3. Create your feature branch (git checkout -b feat/amazing_feature)
  4. Commit your changes (git commit -m 'feat: add amazing_feature').
  5. Push to the branch (git push origin feat/amazing_feature)
  6. Open a Pull Request