misc

BUILDING.md

@@ -1,5 +1,44 @@
 # Build
 
-[tauri.app/start/prerequisites/](https://beta.tauri.app/start/prerequisites/)
+### Prerequisites
 
-[Enigo#runtime-dependencies](https://github.com/enigo-rs/enigo?tab=readme-ov-file#runtime-dependencies)
+- [Rust](https://www.rust-lang.org/tools/install)
+- [Node](https://nodejs.org/en/download/current)
+- [tauri.app/start/prerequisites/](https://beta.tauri.app/start/prerequisites/)
+- [Enigo#runtime-dependencies](https://github.com/enigo-rs/enigo?tab=readme-ov-file#runtime-dependencies)
+
+### Development
+
+To run in development,
+
+1. in both desktop and web folders execute `npm install`
+2. execute `npx tauri dev` in desktop folder
+3. execute `npm run dev` in web folder
+
+A desktop app will open,
+and for the "phone client" a local server will run on localhost:5173
+
+In case you want to try in your phone execute in web folder:
+
+```shell
+npm run dev -- --host 0.0.0.0
+```
+
+### Building
+
+To build for the current platform, execute `cargo tauri build`. On Windows, this will build both NSIS and MSI installers. Both function identically and are located under `src-tauri/target/release/bundle/<msi or nsis>`.
+
+### Debugging
+
+When developing you can see logging messages by setting ENV variable
+
+```
+export RUST_LOG=trace
+npx tauri dev
+```
+
+For forther exploring, you can even try setting
+
+```
+RUST_BACKTRACE=1
+```

README.md

@@ -2,78 +2,45 @@
 
 # mobslide
 
-
 Turn your smartphone into presentation remote controller
 
-
 <br />
 
 <img src="https://github.com/thewh1teagle/mobslide/assets/61390950/64db10d7-ca7e-45cc-a64b-71ce3fad3fb3" width="400px" height="280px" />
 
-<img src="https://github.com/thewh1teagle/mobslide/assets/61390950/571228a3-8b4a-4270-a5de-0fd71adebf72" width="400px" height="280px" /> 
+<img src="https://github.com/thewh1teagle/mobslide/assets/61390950/571228a3-8b4a-4270-a5de-0fd71adebf72" width="400px" height="280px" />
 
 # Install
+
 1. Simply Download `mobslide` from [releases](https://github.com/thewh1teagle/mobslide/releases) on your PC and start it
 
 # I installed, what's now?
+
 Open some presentation in `Powerpoint` / `Google Slides`
 
 Scan the `QR` and control it with your phone!
 
 # Supported plaforms
+
 Works on MacOS and Windows.
 
-Tauri for linux doesn't support webrtc so currently Linux isn't supported 
+Tauri for linux doesn't support webrtc so currently Linux isn't supported
 
 # Presentation platforms
+
 - [Powerpoint](https://www.microsoft.com/en/microsoft-365/powerpoint)
 - [Canva](https://canva.com)
 - [Google Slides](https://slides.google.com/)
 - [KeyNote](https://www.apple.com/keynote/)
 
 # Usage
+
 Scan the QR code with your smartphone and open the link.
 
 <img src="https://github.com/thewh1teagle/mobslide/assets/61390950/4ee89b20-ef0d-488c-925b-92a3b60223a3" />
 
-
-
 # Features
+
 - Scan the QR code. No installation required
 - Lightweight app `~2.5M`
 - Minimal and effective design
-
-## Build
-### Prerequisites
-- [Rust](https://www.rust-lang.org/tools/install)
-- [Node](https://nodejs.org/en/download/current)
-
-### Development
-To run in development, 
-1. in both desktop and web folders execute `npm install`
-2. execute `cargo tauri dev` in desktop folder
-3. execute `npm run dev` in web folder
-
-A desktop app will open,
-and for the "phone client" a local server will run on localhost:5173
-
-In case you want to try in your phone execute in web folder:
-```shell
-npm run dev -- --host 0.0.0.0
-```
-
-### Building
-To build for the current platform, execute `cargo tauri build`. On Windows, this will build both NSIS and MSI installers. Both function identically and are located under `src-tauri/target/release/bundle/<msi or nsis>`.
-
-
-### Debugging
-When developing you can see logging messages by setting ENV variable
-```
-export RUST_LOG=trace
-cargo tauri dev
-```
-
-For forther exploring, you can even try setting
-```
-RUST_BACKTRACE=1
-```