ref: 7ac0fa91a242288cb72828ecfaa36817f65a5348
parent: 5430ccaabfcf82be448a5b25d4a19f642b566fa2
author: Clownacy <Clownacy@users.noreply.github.com>
date: Tue Sep 10 09:27:32 EDT 2019
Add a list of branches to the readme
--- a/README.md
+++ b/README.md
@@ -1,3 +1,15 @@
+## Table of Contents
+
+This repo has multiple branches:
+
+Branch | Description
+--------|--------
+[accurate](https://www.github.com/Clownacy/Cave-Story-Engine-2/tree/accurate) | The main decompilation branch. The code intended to be as close to the original as possible, down to all the bugs and platform-dependencies.
+[portable](https://www.github.com/Clownacy/Cave-Story-Engine-2/tree/portable) | This branch ports the engine to SDL2, and addresses numerous portability issues, allowing it to run on other platforms.
+[enhanced](https://www.github.com/Clownacy/Cave-Story-Engine-2/tree/enhanced) | Based on the portable branch, this adds several enhancements to the engine, and makes it more accessible to modders.
+[emscripten](https://www.github.com/Clownacy/Cave-Story-Engine-2/tree/emscripten) | Modifies the engine to build with Emscripten, [allowing it to run in web browsers](http://sonicresearch.org/clownacy/cave.html).
+[wii](https://www.github.com/Clownacy/Cave-Story-Engine-2/tree/wii) | Ports the engine to the Nintendo Wii.
+
# Cave Story Engine 2
Cave Story Engine 2 is a decompilation of Cave Story.