From 61e8a288c616ea27050f781b35b8c6134f487a7b Mon Sep 17 00:00:00 2001 From: jshp3795 Date: Mon, 29 Jul 2024 14:30:55 +0900 Subject: [PATCH] Update README.md --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 79e6e04..783651f 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,23 @@ My first rust project. New to rust! # Credits Please refer to [Acrillis/Synapse X](https://github.com/Acrillis/SynapseX) for the Synapse X WPF UI source code. +## How to install +You can install the bundle from [releases](https://github.com/DollarNoob/Synapsploit/releases).
+If you want to make modifications, please check 'How to build'.
+Please open [issues](https://github.com/DollarNoob/Synapsploit/issues) if you have suggestions or found bugs.
+Feel free to open [pull requests](https://github.com/DollarNoob/Synapsploit/pulls) for any kind of contribution! + +## How to build +First, install [Rust](https://rustup.rs/) and [node.js](https://nodejs.org/).
+
+Install the npm packages: `npm install`
+
+Now build the bundle:
+ARM64 (Apple Silicon): `npm run tauri build -- --target aarch64-apple-darwin`
+x86 (Intel): `npm run tauri build -- --target x86_64-apple-darwin`
+Universal (Both): `npm run tauri build -- --target universal-apple-darwin`
+
+The bundle will be located at: `Synapsploit/src-tauri/target/{target}/release/bundle/dmg/Synapse X_{version}_{target}.dmg` ## Tauri + SvelteKit + TypeScript This template should help get you started developing with Tauri, SvelteKit and TypeScript in Vite.