README.md

---

Omi3 is an open-source project focused on building audio processing and playback capabilities for web applications.

Project Overview

Omi3 aims to provide developers with a comprehensive set of tools and components for handling audio in web applications. From low-level audio processing to high-level UI components, Omi3 covers a wide range of audio-related functionalities.

Key Features

• Audio processing and manipulation
• Customizable audio playback controls

Project Structure

The project is organized as follows:

.
├── apps/ # Main applications
│   └── site/ # Main website and demo
├── packages/ # Shared packages
│   ├── audio/ # Core audio processing library
│   ├── ui/ # Reusable UI components
│   └── utils/ # Utility functions
└── tools/ # Development tools and configurations
    ├── eslint/ # ESLint configuration
    ├── tailwind/ # Tailwind CSS configuration
    ├── tsup/ # tsup configuration
    └── typescript/ # TypeScript configurations

Getting Started

1. Ensure you have Node.js (>=18), pnpm, and make installed.
2. Clone the repository.
3. Install dependencies:

   pnpm install
   

4. Start the development server:

   pnpm dev
   

Development Workflow

We use a Makefile to streamline our development process. Here are the main commands:

• Update your current branch or a specific branch with the latest changes from main:

  make update
  

  or

  make update BRANCH=your-branch-name
  

• Synchronize the main branch with dev:

  make sync-main
  

• Clean up local branches that have been merged:

  make clean
  

• Prune remote branches that no longer exist:

  make prune
  

• For more information on available commands:

  make help
  

Note: The main production branch is main. Always make sure you're updating from and merging into the correct branch for your specific task.

Contributing

We welcome contributions from the community! Please read our Contributing Guidelines for more information on how to get involved.

License

Omi3 is open-source software licensed under the Apache License 2.0. See the LICENSE file for more details.

---