From 34027af2f4954abb18abc31fb44b999f9cad89e3 Mon Sep 17 00:00:00 2001
From: ayabusa <lebgpub@gmail.com>
Date: Mon, 19 Feb 2024 16:35:52 +0100
Subject: [PATCH] updated README

---
 README.md | 16 ++++++++++++----
 1 file changed, 12 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 441faf7..dd47e38 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,15 @@
-# Tauri + Vanilla
+# Rust Slicer
 
-This template should help get you started developing with Tauri in vanilla HTML, CSS and Javascript.
+The rust slicer is a rust app powered by the tauri framework. It is currently really WIP so use it at your own risk.
 
-## Recommended IDE Setup
+## How to build
+
+1. Install Rust using rustup
+2. Install Tauri
+3. Clone the repo 
+
+    ``` git clone "https://github.com/ayabusa/Rusty-slicer.git" ```
+
+    ```cd Rusty-slicer```
+4. Build using ```cargo tauri dev```
 
-- [VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)