Readme: Add information

attilathedud · Dec 12, 2018 · 34dfbad · 34dfbad
1 parent dc1a1d6
commit 34dfbad
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,2 +1,27 @@
-WIP
+# GBA Explorer
+
+Explore GameBoy Advanced ROMs and see and hear all their data, text, graphics, and sounds. 
+![Hero screenshot](/promos/hero.png?raw=true "Compressed image viewing")
+
+## Header
+View the ROM entry point, debugging information, game title, code, and version. This can be used to see what particular version of a game you have.
+![Header screenshot](/promos/header.png?raw=true "Header section")
+
+## Hexview
+View the raw data of the ROM. Search by offset, byte sequence, and ascii text supported.
+![Hexview screenshot](/promos/hexview.png?raw=true "Hexview section")
+
+## Strings
+By searching for known text strings, you can generate an alphabetic map to dump large sections of undecoded text from the game. 
+![Strings screenshot](/promos/strings.png?raw=true "Strings section")
+
+## Graphics
+View the compressed and uncompressed graphics on the rom to see backgrounds and sprite maps. Supports zoom and tile shifting.
+![Graphics screenshot](/promos/graphics.png?raw=true "Graphics section")
+
+## Sounds
+On games that implement the sappy soundengine, you can listen to their tracks and sounds.
+
+## Development
+This is an electron application built with Vue and Bulma. It functions as an SPA. The decompression code for graphics uses a large amount of code from Nintenlord's work modified to work in Javascript. The decompression code for sound is strongly based on the GBA Sappy Engine Detector by Bregalad.
 
diff --git a/promos/graphics.png b/promos/graphics.png
diff --git a/promos/header.png b/promos/header.png
diff --git a/promos/hero.png b/promos/hero.png
diff --git a/promos/hexview.png b/promos/hexview.png
diff --git a/promos/strings.png b/promos/strings.png