/music-notation-render

Swift Music Notation Package for rendering the model described in music-notation

Primary LanguageSwift

music-notation

Platform Swift 5.3 Swift Package Manager compatible Build & Test Coverage Badge

music-notation-render

This is a work in progress, Cross-Platform Music Notation API written in Swift. This is the package that implements the rendering for the base music-notation package. It is written so that it can be used in most any operating system, such as iOS, macOS, tvOS. Windows & Linux is aspirational at this point, but since the plan is to avoid dependencies, this should not be much of a stretch.

Please consult this Swift style guide for coding style guidelines used in this repo and be sure to adhere to them.

There is a Slack channel you can join if you want to see more into the development process at Music Notation Swift Slack.

Contents

Features

  • Modern Swift API
  • High Performance Music Notation modeling
  • No 3rd party dependencies
  • Comprehensive Unit and Performance Test Coverage
  • Complete Documentation
  • Modular Design for Package Based Extension

Requirements

  • macOS 10.15+ / iOS 13+ / tvOS 13+ / watchOS 7+
  • Swift 5.4+

Note please see Package.swift for the latest Requirements

Installation

WIP This will be either SPM or manual install

Swift Package Manager

WIP

Manual Installation

WIP

Getting Started

WIP

Configuration

WIP Since much of the concrete implementation will be in packages, this will be the main avenue for configuration.

Examples

FAQ

Note

WIP

Contributing

See CONTRIBUTING for guidelines to contribute back to music-notation. This might be a bit premature, but once things start working, please feel free to ask.

License

music-notation is released under the MIT license. See LICENSE for details.