From 5353b17af6b9806afa87f55b8e573c1889fde79c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?hako=E2=AD=90?= Date: Sat, 17 Jun 2023 18:17:13 -0500 Subject: [PATCH] Update README (#633) * Update README * include ENUNU support as a feature --- README.md | 71 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 39 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 024084980..a6e37e80f 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,21 @@ - + # OpenUtau -OpenUtau is an open source editing environment for UTAU community with modern user experience. +OpenUtau is a free, open-source editor made for the UTAU community. [![AppVeyor](https://img.shields.io/appveyor/build/stakira/OpenUtau?style=for-the-badge&label=appveyor&logo=appveyor)](https://ci.appveyor.com/project/stakira/openutau) [![Discord](https://img.shields.io/discord/551606189386104834?style=for-the-badge&label=discord&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/UfpMnqMmEM) [![QQ Qroup](https://img.shields.io/badge/QQ-485658015-blue?style=for-the-badge)](https://qm.qq.com/cgi-bin/qm/qr?k=8EtEpehB1a-nfTNAnngTVqX3o9xoIxmT&jump_from=webapi) [![Trello](https://img.shields.io/badge/trello-go-blue?style=for-the-badge&logo=trello)](https://trello.com/b/93ANoCIV/openutau) -## Getting Started +## Getting started [![Download](https://img.shields.io/static/v1?style=for-the-badge&logo=github&label=download&message=windows-x64&labelColor=FF347C&color=4ea6ea)](https://github.com/stakira/OpenUtau/releases/latest/download/OpenUtau-win-x64.zip)
[![Download](https://img.shields.io/static/v1?style=for-the-badge&logo=github&label=download&message=windows-x86&labelColor=FF347C&color=4ea6ea)](https://github.com/stakira/OpenUtau/releases/latest/download/OpenUtau-win-x86.zip)
[![Download](https://img.shields.io/static/v1?style=for-the-badge&logo=github&label=download&message=macos-x64&labelColor=FF347C&color=4ea6ea)](https://github.com/stakira/OpenUtau/releases/latest/download/OpenUtau-osx-x64.dmg)
[![Download](https://img.shields.io/static/v1?style=for-the-badge&logo=github&label=download&message=linux-x64&labelColor=FF347C&color=4ea6ea)](https://github.com/stakira/OpenUtau/releases/latest/download/OpenUtau-linux-x64.tar.gz) -It is **strongly recommend** to go through a few Wiki pages before use: +It is **strongly recommended** that you read these Github wiki pages before using the software. - [Getting-Started](https://github.com/stakira/OpenUtau/wiki/Getting-Started) - [Resamplers](https://github.com/stakira/OpenUtau/wiki/Resamplers-and-Wavtools) - [Phonemizers](https://github.com/stakira/OpenUtau/wiki/Phonemizers) @@ -23,57 +23,64 @@ It is **strongly recommend** to go through a few Wiki pages before use: - [中文使用说明](https://opensynth.miraheze.org/wiki/OpenUTAU/%E4%BD%BF%E7%94%A8%E6%96%B9%E6%B3%95) -## How to Contribute +## How to contribute -Tried OpenUtau and not satisfied? Don't just walk away! You could help shape it: -- Report issues on [Discord](https://discord.gg/UfpMnqMmEM) or Github. +Tried OpenUtau and not satisfied? Don't just walk away! You can help: +- Report issues on our [Discord server](https://discord.gg/UfpMnqMmEM) or Github. - Suggest features on Discord or Github. -- Add or update translations on Github. +- Add or update translations for your language on Github. -Have coding skills? Don't just fork and keep it to yourself! -- Contribute fixes through Pull Requests. -- See the roadmap on [Trello](https://trello.com/b/93ANoCIV/openutau) and discuss it on Discord. +Know how to code? Got an idea for an improvement? Don't keep it to yourself! +- Contribute fixes via pull requests. +- Check out the development roadmap on [Trello](https://trello.com/b/93ANoCIV/openutau) and discuss it on Discord. -## Plugin Development +## Plugin development +Want to contribute plugins to help other users? Check out our API documentation: - [Editing Macros API Document](OpenUtau.Core/Editing/README.md) - [Phonemizers API Document](OpenUtau.Core/Api/README.md) -## How to Use +## Main features -Fluent Navigation Using Scroll Wheel +Navigate the interface naturally and fluently using the mouse and scroll wheel. Keyboard shortcuts are also available. ![Editor](Misc/GIFs/editor.gif) -Feature-Rich Midi Editor +Easily create songs and covers using the feature-rich MIDI editor. ![Editor](Misc/GIFs/editor2.gif) -Vibrato Editing +Create expressive vibratos with the easy-to-use vibrato editor. ![Vibrato](Misc/GIFs/vibrato.gif) -Render and Playback +Pre-rendering and built-in resamplers let you quickly preview your work. ![Playback](Misc/GIFs/playback.gif) -See [Getting-Started](https://github.com/stakira/OpenUtau/wiki/Getting-Started) for more! +See the [Getting-Started Wiki page](https://github.com/stakira/OpenUtau/wiki/Getting-Started) for more! -## Scope -#### The scope of OpenUtau includes: +## All features - Modern user experience. -- Selected compatibility with UTAU technologies. - - OpenUtau aims to solve problems in less laborious ways, so don't expect it to replicate exact UTAU features. -- Extensible realtime phonetics (VCV, CVVC, Arpasing) intellegence. - - English, Japanese, Chinese, Korean, Russian and more. -- Internationalization, including UI translation and file system encoding support. - - No you don't need to change system locale to use OpenUtau. +- Easy navigation using the mouse and keyboard. +- Feature-rich MIDI editor. + - Support for importing VSQX (Vocaloid 4) tracks. +- Selective backward compatibility with UTAU. + - OpenUtau aims to solve problems with fewer steps. It is not designed to replicate UTAU features exactly. +- Extensible real-time phonetic editing. + - Includes phonemizers for different phonetic systems (VCV, CVVC, Arpasing, etc.) in many different languages (English, Japanese, Chinese, Korean, Russian and more). +- Expressions replace the standard UTAU "flags" for tuning. + - The built-in WORLDLINE-R resampler supports curve tuning, similar to many vocal synth editors. +- Internationalisation, including UI translation and file system encoding support. + - Unlike UTAU, there is no need to change your system locale to use OpenUtau. - Smooth preview/rendering experience. -- A easy to use plugin system. -- An efficient resampling engine interface. + - Pre-rendering allows OpenUtau to render vocals before playback, saving time during editing and tuning. +- Supports ENUNU AI singers. See the ![ENUNU wiki page](https://github.com/stakira/OpenUtau/wiki/Status-of-ENUNU-NNSVS-Support) for more info. +- Easy-to-use plugin system. +- Versatile resampling engine interface. - Compatible with most UTAU resamplers. -- A Windows and a macOS version. +- Runs on Windows (32/64 bit), macOS, and Linux. -#### The scope of OpenUtau does not include: -- Full feature digital music workstation. -- OpenUtau does not strike for Vocaloid compatibility, other than limited features. +### What it doesn't do +- While OpenUtau can do very minimal mixing, it will not replace your digital audio workstation of choice. +- OpenUtau does not aim for Vocaloid compatibility, except for some limited features.