neanes / neanes

Neanes is a free and open source scorewriter for notating Byzantine chant in Byzantine notation.
https://neanes.github.io/neanes/
GNU General Public License v3.0
35 stars 9 forks source link
byzantine-chant byzantine-notation electron music music-notation scorewriter typescript vue

Neanes - A Byzantine Chant Scorewriter

CI

Neanes (pronounced neh-ah-ness) is a free and open source scorewriter for notating Byzantine Chant.

Demo Screen

Features

Purpose

This software is intended to create simple scores that contain:

It is not intended to be a fully-featured word processor.

Examples

Example files can be found in the examples folder.

How to Download

Download the latest release on the releases page. The latest release can also be found here.

A web version of the app with reduced functionality can be found here.

How-to Guide

To learn how to use the software, read the guide.

Building

Prerequisites

Project Setup

First install the project dependencies:

corepack enable npm
npm install

Release Build

To create a release build, type:

npm run build

The build artifacts are found in dist/. For Windows, the installer will be called Neanes Setup [version].exe. The raw files can be found in dist/win_unpacked.

Development

To run the development server, type:

npm run dev

This will launch the application in development mode. As changes are made to the source code, the app will reload automatically.

The Vue Devtools extension is available in development mode. To enable it, add the following to .env.local and/or .env.web.local:

VITE_ENABLE_DEV_TOOLS=true

Any change that updates package.json must include the corresponding update to package-lock.json after running npm install.

Linting

To check that the code is linted, type:

npm run lint

To automatically fix any lint issues, type:

npm run lint:fix

Tests

To run tests before committing, type:

npm test

IDE Support

When using Visual Studio Code, install the following extension:

Localization

To test localization support, add the following to .env.local and/or .env.web.local:

VITE_PSEUDOLOCALIZATION=true

This enables pseudolocalization for all localized strings.

License

This project is licensed under the GNU General Public License, version 3.

The following bundled fonts are licensed under the SIL Open Font License (OFL), version 1.1:

Acknowledgements

This software uses the "EZ" Byzantine Music Font Package created at St. Anthony's Greek Orthodox Monastery. See the monastery's website for more details. Thank you for your work on these fonts, without which this program would not be possible.