Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bruceunx committed Dec 10, 2024
1 parent 558368b commit d898760
Show file tree
Hide file tree
Showing 3 changed files with 89 additions and 0 deletions.
82 changes: 82 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
name: Build and Release Tauri App

on:
push:
tags:
- "v*.*.*" # Trigger workflow on version tags like v1.0.0

jobs:
build:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]

steps:
# Checkout the repository
- name: Checkout code
uses: actions/checkout@v3

# Install Rust
- name: Setup Rust
uses: actions-rs/toolchain@v1
with:
toolchain: stable
target: ${{ matrix.os == 'windows-latest' && 'x86_64-pc-windows-msvc' || 'x86_64-unknown-linux-gnu' }}

# Install Node.js
- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: 18

# Install dependencies
- name: Install dependencies
run: npm install

# Build the Tauri app
- name: Build Tauri App
run: npm run tauri build

# Upload artifacts
- name: Upload build artifacts
uses: actions/upload-artifact@v3
with:
name: ${{ runner.os }}-artifacts
path: |
src-tauri/target/release/bundle/dmg/*.dmg
src-tauri/target/release/bundle/msi/*.msi
src-tauri/target/release/bundle/appimage/*.AppImage
# Create GitHub Release
- name: Create Release
uses: actions/create-release@v1
with:
tag_name: ${{ github.ref_name }}
release_name: Release ${{ github.ref_name }}
body: |
This release contains the following builds:
- macOS: dmg
- Windows: exe/msi
- Linux: AppImage
draft: false
prerelease: false
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

# Upload Release Assets
- name: Upload Release Assets
uses: actions/upload-release-asset@v1
with:
upload_url: ${{ steps.create_release.outputs.upload_url }}
asset_path: src-tauri/target/release/bundle/dmg/*.dmg
asset_name: videomaestro-macos.dmg
asset_content_type: application/x-diskimage
- name: Upload Release Assets
uses: actions/upload-release-asset@v1
with:
upload_url: ${{ steps.create_release.outputs.upload_url }}
asset_path: src-tauri/target/release/bundle/msi/*.msi
asset_name: videomaestro-windows.msi
asset_content_type: application/x-msi
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,5 @@ cache/
src-tauri/binaries/

**/.env

!.github/
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

Welcome to Video Maestro! 🚀 (formerly known as Video Manager), your ultimate desktop app for managing and transforming video content from platforms like YouTube. Built with the power of Tauri 🦀 and ReactJS ⚛️, this app is a one-stop solution for creators, researchers, and enthusiasts.

> [!IMPORTANT]
> Video Maestro support youtube with/without subtitles. If the video has subtitles, then use subtitles by default, otherwise transform audio to transcripts first
## 📸 Screen Shot

<p align="center">
<img src="docs/screenshot1.png" alt="Video Maestro Screenshot" width="600">
</p>
Expand Down

0 comments on commit d898760

Please sign in to comment.