Skip to content

Commit

Permalink
README: use more traditional markdown-syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
kusma committed Feb 17, 2018
1 parent 8bf11ce commit fe20fef
Showing 1 changed file with 21 additions and 22 deletions.
43 changes: 21 additions & 22 deletions README.md
@@ -1,5 +1,4 @@
Rocket
======
# Rocket

[![Build status](https://ci.appveyor.com/api/projects/status/dfq8qaedc6mtsefg/branch/master?svg=true)](https://ci.appveyor.com/project/kusma/rocket/branch/master)
[![Build status](https://travis-ci.org/rocket/rocket.svg?branch=master)](https://travis-ci.org/rocket/rocket)
Expand All @@ -12,15 +11,15 @@ consists of a GUI editor (using Qt), 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
--------------
## Compile Editor

The Rocket editor uses qmake as a build-system abstraction, which can be
used to output Makefiles, Visual Studio project files or can be built
directly from QtCreator. See the qmake documentation for details.

Compile Example
---------------
Rocket contains an example client called example\_bass. This is a simple
## Compile Example

Rocket contains an example client called `example_bass`. This is a simple
OpenGL, SDL 1.2 and BASS audio library application, that demonstrates how to
use the Rocket API.

Expand All @@ -32,30 +31,30 @@ If you're using VS2013 or above, this should happen automatically, as
these libraries are consumed through NuGet.

The header files and libraries can be installed local to the project by
copying all .lib-files to the example\_bass/lib/, all .h files to
example\_bass/include/, and all .dll files to the example\_bass/.
copying all .lib-files to the `example_bass/lib/`, all .h files to
`example_bass/include/`, and all .dll files to the `example_bass/`.

Once the prerequisites are installed, the example can be compiled either by
opening examples.sln and selecting "Build" -> "Build Solution" from Visual
opening examples.sln and selecting `Build` -> `Build Solution` from Visual
Studio 2008 or 2013, or by doing `make examples/example_bass` on Unix-based
systems.

JavaScript
----------
## JavaScript

Thanks to the excellent work of [mog](http://github.com/mog), there's now
JavaScript support. Have a look at [js/README.md](js/README.md) for more
information.

Using the editor
----------------
## Using the editor

The Rocket editor is laid out like a music-tracker; tracks (or columns) and
rows. Each track represents a separate "variable" in the demo, over the entire
time-domain of the demo. Each row represents a specific point in time, and
consists of a set of key frames. The key frames are interpolated over time
according to their interpolation modes.

Interpolation modes
-------------------
### Interpolation modes

Each key frame has an interpolation mode associated with it, and that
interpolation mode is valid until the next key frame is reached. The different
interpolation modes are the following:
Expand All @@ -70,8 +69,8 @@ interpolation modes are the following:
* Ramp : This is similar to "Linear", but additionally applies an
exponentiation of the interpolation factor.

Keyboard shortcuts
-------------------
### Keyboard shortcuts

Some of the Rocket editor's features are available through the menu and some
keyboard shortcut. Here's a list of the supported keyboard shortcuts:

Expand All @@ -98,8 +97,8 @@ keyboard shortcut. Here's a list of the supported keyboard shortcuts:
| Ctrl+PgUp/PgDn | Quick-bias by +/- 10 |
| Shift+Ctrl+PgUp/PgDn | Quick-bias by +/- 100 |

Alternatives and ports
----------------------
## Alternatives and ports

* [PBRocket](https://github.com/dartcode/pbrocket), a PureBasic port of the
Rocket editor, client and player.
* [RocketEditor](https://github.com/emoon/rocket), an
Expand All @@ -117,7 +116,7 @@ Alternatives and ports
implementation of the client and player. Crate available
[here](https://crates.io/crates/rust-rocket).

Bugs and feedback
-----------------
## Bugs and feedback

Please report bugs or other feedback to the Rocket mailing list:
<rocket-dev@googlegroups.com>

0 comments on commit fe20fef

Please sign in to comment.