diff --git a/docs/src/index.md b/docs/src/index.md index 18d46597e..8c404a012 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -7,79 +7,80 @@ Zooshi {#zooshi_index} [Zooshi][] is a game in which players travel on a raft down an endless river and toss sushi into the mouths of well-dressed animal patrons. It is written in cross-platform C++. - +``` \htmlonly \endhtmlonly +```` ## Motivation -[Zooshi][] demonstrates a quick and fun game that primarily targets -[Google Cardboard][] using native C++ APIs. The game shows how to use +[Zooshi] demonstrates a quick and fun game that primarily targets +[Google Cardboard] using native C++ APIs. The game shows how to use several open source technology components developed at Google.
- - [Breadboard][], an event system that allows game components to communicate + + [Breadboard], an event system that allows game components to communicate with each other, without being tightly coupled. |
- - [CORGI][], a simple, yet flexible, [entity-component system][] that + + [CORGI], a simple, yet flexible, [entity-component system][] that decouples the systems within the game. |
- - [FlatBuffers][], a fast serialization system is used to store the game's + + [FlatBuffers], a fast serialization system is used to store the game's data. The game configuration data is stored in JSON files which are converted to FlatBuffer binary files using the flatc compiler. |
- - [FlatUI][], an immediate-mode GUI designed specifically with games in mind. + + [FlatUI], an immediate-mode GUI designed specifically with games in mind. The game uses FlatUI to generate all of the menus in the game. |
- - [fplbase][], is as a thin renderer and asset management library used by the + + [fplbase], is as a thin renderer and asset management library used by the game. |
- - [Google Play Games Services][] is used to share scores and reward players + + [Google Play Games Services] is used to share scores and reward players with achievements. |
- - [MathFu][], a geometry math library optimized for ARM and x86 processors. + + [MathFu], a geometry math library optimized for ARM and x86 processors. The game uses MathFu data types for two and three dimensional vectors, and - for the 4x4 matrices used by the [fplbase][] rendering system, and also by - the [Motive][] animation system. + for the 4x4 matrices used by the [fplbase] rendering system, and also by + the [Motive] animation system. - [Motive][], a memory efficient and performant animation library. The game + [Motive], a memory efficient and performant animation library. The game uses Motive for all of the animation. |
- - [Pindrop][], a simple audio engine designed with games in mind. It handles + + [Pindrop], a simple audio engine designed with games in mind. It handles all the audio of the game. |
- - [WebP][], an image compression technology, is used to compress textures + + [WebP], an image compression technology, is used to compress textures which reduces the size of the final game package and ultimately reduces download time. |