Skip to content

Conversation

@IdrisGit
Copy link
Contributor

@IdrisGit IdrisGit commented Feb 7, 2026

Pull Request Template

Description

  • Add a install script at the root of the project and a curl command to execute it in the README, it will auto detect user's system and take the necessary like installing the app in relevant directory on Linux and Mac and app installer on Windows
  • Update electron builder and GH actions, to produce builds and publish them using the release tags and create necessary checksums for the install script integrity check.

Motivation

While the current documented method of downloading the asset and copying to the relevant directory and running it or adding it to $PATH is a very trivial thing and the install script is necessarily doing the same thing at it's core, it can be a friction for adoption as alot of people don't know these things and people are used to give me the command to install.

This should help with adoption and future maintenance

Type of Change

  • New Feature
  • Bug Fix
  • Refactor / Code Cleanup
  • Documentation Update
  • Other (please specify)

Testing

I have tested this locally without checksum on a linux machine and it's working fine, I don't have a mac or windows machine right now to test it.

  • checkout the branch and run the "./install" and it should work ideally
  • I am opening this as a draft with RFC to get the maintainers input on this

Checklist

  • I have performed a self-review of my code.
  • I have added any necessary screenshots or videos.
  • I have linked related issue(s) and updated the changelog if applicable.

Thank you for contributing!

@IdrisGit IdrisGit force-pushed the feat-add-install-script branch 2 times, most recently from 21333ee to 40b9a77 Compare February 7, 2026 12:25
@IdrisGit IdrisGit force-pushed the feat-add-install-script branch from 40b9a77 to 0246163 Compare February 7, 2026 12:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant