Add Documentation of Applications

README.md

@@ -0,0 +1,92 @@
+# [MALVEKE] ***GAME BOY*** Cartridge (GB/GBC)
+
+https://github.com/EstebanFuentealba/MALVEKE-Flipper-Zero/assets/442927/eb23a0df-de86-43dc-a554-a9cd4421cca3
+
+
+<figure>
+    <img src="./docs/images/proto.jpg" />
+    <figcaption>MALVEKE Prototype V2.3</figcaption>
+</figure>
+
+## Introduction
+
+<div align="center">
+
+**Official** | **Unleashed** | **RogueMaster** | **Xtreme**
+:- | :- | :- | :- 
+[![FlipC.org](https://flipc.org/EstebanFuentealba/MALVEKE-Flipper-Zero/badge?root=flipper_companion_apps/malveke_gb_cartridge&branch=main)](https://flipc.org/EstebanFuentealba/MALVEKE-Flipper-Zero?root=flipper_companion_apps/malveke_gb_cartridge&branch=main)|[![FlipC.org](https://flipc.org/EstebanFuentealba/MALVEKE-Flipper-Zero/badge?root=flipper_companion_apps/malveke_gb_cartridge&branch=main&firmware=unleashed)](https://flipc.org/EstebanFuentealba/MALVEKE-Flipper-Zero?root=flipper_companion_apps/malveke_gb_cartridge&branch=main&firmware=unleashed)|[![FlipC.org](https://flipc.org/EstebanFuentealba/MALVEKE-Flipper-Zero/badge?root=flipper_companion_apps/malveke_gb_cartridge&branch=main&firmware=roguemaster)](https://flipc.org/EstebanFuentealba/MALVEKE-Flipper-Zero?root=flipper_companion_apps/malveke_gb_cartridge&branch=main&firmware=roguemaster)|[![FlipC.org](https://flipc.org/EstebanFuentealba/MALVEKE-Flipper-Zero/badge?root=flipper_companion_apps/malveke_gb_cartridge&branch=main&firmware=xtreme)](https://flipc.org/EstebanFuentealba/MALVEKE-Flipper-Zero?root=flipper_companion_apps/malveke_gb_cartridge&branch=main&firmware=xtreme)
+</div>
+<br>
+
+### Features
+- Read info from GAME BOY/GAME BOY Color Cartridges
+- Backing up and restoring your saves (RAM)
+- Backing up and restoring your games (ROM) (WIP)
+
+
+
+## Instructions for use.
+
+These instructions assume that you are starting at the Flipper Zero desktop. Otherwise, press the Back button until you are at the desktop.
+
+- Press the `OK` button on the Flipper to open the main menu.
+- Choose `Applications` from the menu.
+- Choose `GPIO` from the submenu.
+- Choose `[MALVEKE] GAME BOY Cartridge (GB/GBC)`
+
+    <p align='center'>
+        <br />
+        <img src="./docs/images/flipper-zero-flat-1.png" width="400" />
+        <br />
+    </p>
+
+- If the **MALVEKE** board and the cartridge are connected, The Flipper Zero will show the loading screen of the application.
+
+    <p align='center'>
+        <br />
+        <img src="./docs/images/flipper-zero-flat-2.png" width="400" />
+        <br />
+    </p>
+
+- Press the `OK` to enter to menu.
+
+    <p align='center'>
+        <br />
+        <img src="./docs/images/flipper-zero-flat-3.png" width="400" />
+        <br />
+    </p>
+    
+    - Select `Cartridge Information` to view details about the inserted cartridge.
+
+    
+    <p align='center'>
+        <br />
+        <img src="./docs/images/flipper-zero-flat-4.png" width="400" />
+        <br />
+    </p>
+
+
+    - Select `Dump ROM Cartridge` to create a complete backup of the game into a file. This file will be saved in the directory `SD Card/apps_data/malveke/roms` and can be loaded into GAME BOY emulators.
+
+    <p align='center'>
+        <br />
+        <img src="./docs/images/flipper-zero-flat-6.gif" width="400" />
+        <br />
+    </p>
+
+    - Choose `Dump RAM Cartridge` to create a backup of the game state, which stores the progress of a specific video game. This file will be saved in the directory `SD Card/apps_data/malveke/rams`.
+
+    <p align='center'>
+        <br />
+        <img src="./docs/images/flipper-zero-flat-6.gif" width="400" />
+        <br />
+    </p>
+- Press the `Back` to back to principal menu.
+
+
+
+<p align='center'>
+<br />
+<br />
+From Talcahuano 🇨🇱 with ❤ 
+</p>