Git Product home page Git Product logo

music-notation-render's Introduction

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.

music-notation-render's People

Contributors

woolie avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.