search

quietkiro / quickstitch_bin

CLI and GUI applications for using Quickstitch
MIT License
1 stars 1 forks source link

Help #1

Open Adbs23 opened 5 days ago

Adbs23 commented 5 days ago

Hi, I don’t know how to use this program, and I don’t have much experience with this kind of thing. Could someone please help me? I’d really appreciate it.

quietkiro commented 5 days ago

Hi! Sorry, this is currently in active development and currently lacks a user guide. Proper documentation will be made for this sometime in December, but no guarantees as I'm a little busy with other matters.

That said, the CLI should now be working to some extent (I hope you're comfortable with the terminal). Currently, there are no pre-built releases, so you'll have to build the quickstitch CLI from source.

Prerequisites:

How to build:

  1. Clone the git repository with git clone https://github.com/quietkiro/quickstitch_bin.git (or if you don't have git set up, download the ZIP file of the repository).
  2. Enter the directory in the terminal with cd quickstitch_bin (or open the terminal in the quickstitch_bin folder)
  3. Run cargo build --bin quickstitch_cli --release
  4. The CLI should be available at quickstitch_bin/target/release/quickstitch_cli (or quickstitch_cli.exe if you're on Windows).

Using the CLI involves going to the folder with the executable and doing ./quickstitch_cli --help.

If you're not comfortable with using a CLI application, a pre-built GUI version should be ready sometime near late December. Hope this helps!

y-mx-b commented 4 days ago

You can run cargo install --path quickstitch_cli to have Cargo install the binary locally so you can just call it with quickstitch_cli --help. Also note that you would need to add ~/.cargo/bin/ to your PATH environment variable.