search

ZacharyL2 / KeyEcho

Listen to Mechanical Keyboard Sounds with Every Keystroke - It's Fast
GNU Affero General Public License v3.0
465 stars 10 forks source link

(Documentation request) How to build #13

Open hardBSDk opened 2 weeks ago

hardBSDk commented 2 weeks ago

Add the instructions to build this program on the README.

ZacharyL2 commented 2 weeks ago

I've added a brief documentation, and I will provide more details when I have time.

Atomized-titan commented 1 week ago

@hardBSDk just do the following:

  1. Change directory to src-tauri: 
    cd src-tauri
  2. Build the project using Cargo: 
    cargo build
  3. Run the project using Cargo: 
    cargo run

Then, from the root of the app, run:

pnpm dev

Installation Instructions

Installing Cargo

Cargo is the package manager for Rust. If you don't have it installed, you can install it by following the instructions in the Rust documentation.

Installing pnpm

pnpm is a fast, disk space-efficient package manager for JavaScript. If you don't have it installed, you can install it by following the instructions in the pnpm documentation.