From e2e18b9f2114e1679a5e881b9c68f1d83dc13592 Mon Sep 17 00:00:00 2001 From: thewh1teagle <61390950+thewh1teagle@users.noreply.github.com> Date: Sat, 4 May 2024 03:31:29 +0300 Subject: [PATCH] misc --- BUILDING.md | 43 +++++++++++++++++++++++++++++++++++++++++-- README.md | 49 ++++++++----------------------------------------- 2 files changed, 49 insertions(+), 43 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index 44957e0..6ca9581 100644 --- a/BUILDING.md +++ b/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) \ No newline at end of file +- [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/`. + +### 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 +``` diff --git a/README.md b/README.md index 750c32c..3d90e3f 100644 --- a/README.md +++ b/README.md @@ -2,78 +2,45 @@ # mobslide - Turn your smartphone into presentation remote controller -
- + # 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. - - # 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/`. - - -### 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 -```