Skip to content

docs: add README.md #130

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yinanazhou merged 1 commit into from
May 27, 2025
Merged

docs: add README.md #130

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,7 @@
# Cress
# Cress

Cress is a browser-based MEI mapping tool. It allows users to map an image of a musical glyph to its corresponding MEI encoding in neume notation. The MEI output is validated against MEI version 5.0.

# Cress for Developers

Please refer to the [Cress Wiki](https://github.com/DDMAL/Cress/wiki) for instructions on development and deployment using GitHub Pages.
Copy link
Copy Markdown

@notkaramel notkaramel May 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think sending them directly to the dev wiki would be more efficient

Please refer to the Cress Wiki for instructions on
- Development: https://github.com/DDMAL/Cress/wiki/Dev:-Set-up-Cress-Locally
- Deployment via GitHub Page: https://github.com/DDMAL/Cress/wiki/Build-and-Deploy-Cress-Via-GitHub-Pages