Update and rename README to README.md
Changed the README to markdown and updated the content.
This commit is contained in:
1 parent
cbded1c7fb
commit
ee77df7523
2 files changed
+49
-50
No files matched your search
@@ -0,0 +1,49 @@
|
||||

|
||||
|
||||
[1. About]()
|
||||
[2. Download]()
|
||||
[3. Contributing]()
|
||||
[4. Help & Support]()
|
||||
|
||||
|
||||
## 1. About
|
||||
Vocaluxe is a free and open source singing game, inspired by the original UltraStar (developed by corvus5) and the great Ultrastar Deluxe project - yet it is an entirely new development in C#.
|
||||
It allows up to six players to sing along with music using microphones in order to score points, depending on the pitch of the voice and the rhythm of singing.
|
||||
It features mouse, keyboard, gamepad and Wiimote navigation, a multi-language interface, and singer profiles with avatars and supports songs in CP1250/52 and UTF8 encodings.
|
||||
|
||||
Supported Operating Systems / Requirements:
|
||||
- WinXP, Vista, Windows 7 with .NET 4.0
|
||||
- 1 GHz CPU, 512 MB RAM, Graphics card with OpenGL 2.1 or DirectX 9.0 support
|
||||
|
||||
|
||||
## 2. Download
|
||||
You can download precompiled Windows binaries at here:
|
||||
http://vocaluxe.sourceforge.net/index.php?p=download
|
||||
|
||||
Nightly builds are available here:
|
||||
https://github.com/Vocaluxe/Vocaluxe/releases
|
||||
|
||||
## 3. Contributing
|
||||
You want to fix a bug or add a cool new feature to Vocaluxe? Awesome!
|
||||
|
||||
### Build Vocaluxe
|
||||
Building Vocaluxe is easy:
|
||||
Just follow the guide on our wiki to clone the repository and create your own Vocaluxe build:
|
||||
[Build Vocaluxe (Windows)](https://github.com/Vocaluxe/Vocaluxe/wiki/HowTo:-Build-Vocaluxe-(Windows))
|
||||
|
||||
### Submit your change
|
||||
Upload your changes to your fork and open a new pull request.
|
||||
|
||||
The development of Vocaluxe uses this git branching model:
|
||||
http://nvie.com/posts/a-successful-git-branching-model/
|
||||
|
||||
### Questions
|
||||
You have a problem or a question implementing your change?
|
||||
Just [open an issue](https://github.com/Vocaluxe/Vocaluxe/issues/new) or mention `@Vocaluxe` in a comment on GitHub.
|
||||
|
||||
## 4. Help & Support
|
||||
GitHub Wiki: https://github.com/Vocaluxe/Vocaluxe/wiki
|
||||
GitGub Issues Tracker: https://github.com/Vocaluxe/Vocaluxe/issues
|
||||
Translations: https://www.transifex.com/projects/p/vocaluxe/
|
||||
Support Forum (German): http://www.ultra-star.de
|
||||
Song-Database (USDB): http://usdb.animux.de/
|
||||
Reference in new issue
Block a user