Projects/Vocaluxe
2
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #177 from lukeIam/newReadme

Browse Source 
New README
This commit is contained in:
Florian Küpper committed 2015-12-22 08:57:49 +01:00
2 parents b6d5874b62 feafec755e
commit e5c962325e
2 files changed
+50 -50
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

README
-50
View File
@@ -1,50 +0,0 @@
__ __ _
\ \ / /__ ___ __ _| |_ ___ _____
\ \ / / _ \ / __/ _` | | | | \ \/ / _ \
\ V / (_) | (_| (_| | | |_| |> < __/
\_/ \___/ \___\__,_|_|\__,_/_/\_\___|
=================================
= 1. About =
= 2. Download =
= 3. Development Guidelines =
= 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 three players (currently) 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 and keyboard 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 SourceForge:
http://sourceforge.net/projects/vocaluxe/
=================================
= 3. Development Guidelines =
=================================
The development of Vocaluxe uses this git branching model:
http://nvie.com/posts/a-successful-git-branching-model/
=================================
= 4. Help & Suppport =
=================================
GitHub Wiki: https://github.com/Vocaluxe/Vocaluxe/wiki
GitGub Issues Tracker: https://github.com/Vocaluxe/Vocaluxe/issues
Bug Tracker: http://84.200.73.138/redmine/projects/vocaluxe
Translations: https://www.transifex.com/projects/p/vocaluxe/
Support Forum (German): http://www.ultra-star.de
Song-DataBase (USDB): http://usdb.animux.de/
README.md
+50
View File
@@ -0,0 +1,50 @@
![Vocaluxe Logo](https://raw.githubusercontent.com/Vocaluxe/Vocaluxe/develop/Output/Graphics/Logo.png)
[1. About](#1-about)
[2. Download](#2-download)
[3. Contributing](#3-contributing)
[4. Help & Support](#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.
Vocaluxe offers diversified party modes and can optionally be controlled via Browser/App.
Supported Operating Systems / Requirements:
- WinXP, Vista, Windows 7, Windows 8, Windows 8.1 and Windows 10 with .NET 4.0
- Linux (tested on Arch Linux)
- 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
GitHub 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/