aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 20 insertions, 7 deletions
diff --git a/README.md b/README.md
index f9037f4..e9bb7a7 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,15 @@
-# melonDS
-
+<p align="center"><img src="https://raw.githubusercontent.com/StapleButter/melonDS/master/icon/melon_128x128.png"></p>
+<h2 align="center"><b>melonDS</b></h2>
+<p align="center">
+<a href="http://melonds.kuribo64.net/" alt="melonDS website"><img src="https://img.shields.io/badge/website-melonds.kuribo64.net-%2331352e.svg"></a>
+<a href="http://melonds.kuribo64.net/downloads.php" alt="Release: 0.7"><img src="https://img.shields.io/badge/release-0.7-%235c913b.svg"></a>
+<a href="https://www.gnu.org/licenses/gpl-3.0" alt="License: GPLv3"><img src="https://img.shields.io/badge/License-GPL%20v3-%23ff554d.svg"></a>
+<a href="https://kiwiirc.com/client/irc.badnik.net/?nick=IRC-Source_?#melonds" alt="IRC channel: #melonds"><img src="https://img.shields.io/badge/IRC%20chat-%23melonds-%23dd2e44.svg"></a>
+</p>
DS emulator, sorta
The goal is to do things right and fast, akin to blargSNES (but hopefully better). But also to, you know, have a fun challenge :)
-
-The source code is provided under the GPLv3 license.
+<hr>
## How to use
@@ -12,7 +17,7 @@ melonDS requires BIOS/firmware copies from a DS. Files required:
* bios7.bin, 16KB: ARM7 BIOS
* bios9.bin, 4KB: ARM9 BIOS
* firmware.bin, 128/256/512KB: firmware
-
+
Firmware boot requires a firmware dump from an original DS or DS Lite.
DS firmwares dumped from a DSi or 3DS aren't bootable and only contain configuration data, thus they are only suitable when booting games directly.
@@ -51,7 +56,7 @@ Build system is not set in stone.
* support for rendering screens to separate windows
* emulating some fancy addons
* other non-core shit (debugger, graphics viewers, cheat crapo, etc)
-
+
### TODO LIST FOR LATER
* hardware renderer for 3D (w/ upscaling and fancy shit)
@@ -60,9 +65,17 @@ Build system is not set in stone.
* big-endian compatibility (Wii, etc)
* LCD refresh time (used by some games for blending effects)
* any feature you can eventually ask for that isn't outright stupid
-
+
## Credits
* Martin for GBAtek, a good piece of documentation
* Cydrak for the extra 3D GPU research
* All of you comrades who have been testing melonDS, reporting issues, suggesting shit, etc
+
+## License
+[![GNU GPLv3 Image](https://www.gnu.org/graphics/gplv3-127x51.png)](http://www.gnu.org/licenses/gpl-3.0.en.html)
+
+melonDS is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.