Skip to content

Getting Started

Salem874 edited this page Apr 3, 2026 · 1 revision

πŸš€ Getting Started

Copyright Β© 2026 MWBM Partners Ltd. All rights reserved.

Prerequisites

Requirement Version Notes
macOS 15.0+ (Sequoia) Primary development platform
Xcode 16.3+ Includes Swift 6.3
Swift 6.3 Released March 2026
FFmpeg Latest For development: brew install ffmpeg
Git Latest Source control

Building from Source

# Clone the repository
git clone https://github.com/MWBMPartners/MeedyaConverter.git
cd MeedyaConverter

# Build all targets (debug)
swift build

# Build release configuration
swift build -c release

# Run the CLI tool
swift run meedya-convert

# Run tests
swift test

Project Structure

MeedyaConverter/
β”œβ”€β”€ Package.swift               # SPM package definition
β”œβ”€β”€ Sources/
β”‚   β”œβ”€β”€ ConverterEngine/        # Core library (cross-platform)
β”‚   β”œβ”€β”€ meedya-convert/         # CLI executable
β”‚   └── MeedyaConverter/        # macOS SwiftUI app
β”œβ”€β”€ Tests/                      # Unit & integration tests
β”œβ”€β”€ Resources/                  # Built-in profiles & help
β”œβ”€β”€ Tools/                      # Bundled third-party tools
β”œβ”€β”€ help/                       # User documentation
β”œβ”€β”€ .github/                    # CI/CD & templates
└── .claude/                    # AI development context

Development Workflow

  1. Create or pick a GitHub Issue for your task
  2. Create a feature branch from alpha (or beta for fixes)
  3. Write code with detailed annotations and copyright headers
  4. Run swift build and swift test β€” ensure both pass
  5. Create a PR targeting the appropriate branch
  6. After merge, the CI pipeline handles builds automatically

Branch Strategy

Branch Purpose Releases
main Stable production Tagged vX.Y.Z
beta Beta testing Tagged vX.Y.Z-beta.N
alpha Active development Tagged vX.Y.Z-alpha.N

IDE Setup

VSCode

Recommended extensions (included in .vscode/extensions.json):

  • sswg.swift-lang β€” Swift language support
  • vadimcn.vscode-lldb β€” LLDB debugger
  • gruntfuggly.todo-tree β€” TODO tracking
  • yzhang.markdown-all-in-one β€” Markdown editing

Xcode

Open the package directly:

open Package.swift

Or generate an Xcode project:

swift package generate-xcodeproj

Clone this wiki locally