diff --git a/.github/workflows/deploy_desktop.yaml b/.github/workflows/deploy_desktop.yaml new file mode 100644 index 0000000..386ff37 --- /dev/null +++ b/.github/workflows/deploy_desktop.yaml @@ -0,0 +1,62 @@ +name: Release +on: + push: + tags: + - 'v*' + workflow_dispatch: + +jobs: + release: + permissions: + contents: write + strategy: + fail-fast: false + matrix: + platform: [macos-latest, ubuntu-20.04, windows-latest] + runs-on: ${{ matrix.platform }} + env: + working-directory: ./desktop + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Install dependencies (ubuntu only) + if: matrix.platform == 'ubuntu-20.04' + # You can remove libayatana-appindicator3-dev if you don't use the system tray feature. + run: | + sudo apt-get update + sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.0-dev libayatana-appindicator3-dev librsvg2-dev + + - name: Rust setup + uses: dtolnay/rust-toolchain@stable + + - name: Rust cache + uses: swatinem/rust-cache@v2 + with: + workspaces: './desktop/src-tauri -> target' + + - name: Sync node version and setup cache + uses: actions/setup-node@v4 + with: + node-version: 'lts/*' + cache: 'npm' # Set this to npm, yarn or pnpm. + cache-dependency-path: desktop/package-lock.json + + - name: Install frontend dependencies + # If you don't have `beforeBuildCommand` configured you may want to build your frontend here too. + run: npm install # Change this to npm, yarn or pnpm. + working-directory: ${{env.working-directory}} + + - name: Build the app + uses: tauri-apps/tauri-action@v0 + + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + tagName: ${{ github.ref_name }} # This only works if your workflow triggers on new tags. + releaseName: 'App Name v__VERSION__' # tauri-action replaces \_\_VERSION\_\_ with the app version. + releaseBody: 'See the assets to download and install this version.' + releaseDraft: true + prerelease: false + projectPath: ${{env.working-directory}} diff --git a/README.md b/README.md index b33e826..89df5c3 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,42 @@ + + # mobslide - Turn your smartphone into presentation remote controller + +
+ + + + + + + + # Install 1. Simply Download `mobslide.exe` from [releases](https://github.com/thewh1teagle/mobslide/releases) on your PC and start it # Usage -1. Scan the QR code with your smartphone and open the link. -Keys: +Scan the QR code with your smartphone and open the link. + +# Keys - `+` Volume up - `-` Volume down - `Arrow Up` Next - `Arrow Down` Previous - `Arrow Up Long Press` Start presentation + - `Arrow Down Long Press` Stop presentation +## Build +### Prerequisites +- [Rust](https://www.rust-lang.org/tools/install) +- [Node](https://nodejs.org/en/download/current) + +### Development +To run in development, execute `cargo tauri dev`. + +### 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/`.