add a README-file

This commit is contained in:
Erik Faye-Lund 2010-03-15 18:24:25 +01:00
parent 874c5b8ede
commit e6a7dca881

37
README Normal file
View File

@ -0,0 +1,37 @@
GNU Rocket
==========
GNU Rocket is an intuitive new way of... bah, whatever. It's a sync-tracker,
a tool for synchronizing music and visuals in demoscene productions. It
consists of a GUI editor that runs on Microsoft Windows, and an ANSI C
library that can either communicate with the editor over a network socket,
or play back an exported data-set.
Compile Editor
--------------
GNU Rocket compiles using Microsoft Visual Studio 2008. Open editor.sln and
select "Build" -> "Build Solution" from the menu to build the editor.
Compile Example
---------------
GNU Rocket contains an example client called example_bass. This is a simple
Direct3D 9.0 and BASS audio library application, that demonstrates how to
use the GNU Rocket API.
Before compiling the example, you need to make sure you have a recent
Microsoft DirectX and BASS SDKs. These can be downloaded from the following
web-sites:
http://msdn.microsoft.com/directx/
http://www.un4seen.com/
Once the prerequisites are installed, the example can be compiled much like
the editor; by opening examples.sln and selecting "Build" -> "Build Solution"
from the menu.
Bugs and feed-back
------------------
Please report bugs or other feed-back to the GNU Rocket mailing list:
rocket-users@lists.sourceforge.net
Patches or technical questions can be sent to the developer-list:
rocket-developers@lists.sourceforge.net