piwalker/melonDS
1
0
Fork 0
mirror of https://github.com/melonDS-emu/melonDS.git synced 2024-11-14 21:37:42 -07:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix README formatting

Browse Source
This commit is contained in:
Roger 2017-10-21 23:58:02 -04:00 committed by GitHub
parent 3881b2615b
commit cb16e5d03f
1 changed files with 17 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -1,14 +1,12 @@
# melonDS # melonDS
DS emulator, sorta
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 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. The source code is provided under the GPLv3 license.
## How to use
How to use:
melonDS requires BIOS/firmware copies from a DS. Files required: melonDS requires BIOS/firmware copies from a DS. Files required:
* bios7.bin, 16KB: ARM7 BIOS * bios7.bin, 16KB: ARM7 BIOS
@ -18,7 +16,8 @@ melonDS requires BIOS/firmware copies from a DS. Files required:
Firmware boot requires a firmware dump from an original DS or DS Lite. 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. 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.
Possible firmware sizes: ### Possible firmware sizes
* 128KB: DSi/3DS DS-mode firmware (reduced size due to lacking bootcode) * 128KB: DSi/3DS DS-mode firmware (reduced size due to lacking bootcode)
* 256KB: regular DS firmware * 256KB: regular DS firmware
* 512KB: iQue DS firmware * 512KB: iQue DS firmware
@ -27,31 +26,32 @@ DS BIOS dumps from a 3DS can be used with no compatibility issues. DSi BIOS dump
As for the rest, the interface should be pretty straightforward. If you have a question, don't hesitate to ask, though! As for the rest, the interface should be pretty straightforward. If you have a question, don't hesitate to ask, though!
## How to build
How to build: ### Linux:
Linux: ```sh
* mkdir -p build mkdir -p build
* cd build cd build
* cmake .. cmake ..
* make make
```
### Windows:
Windows:
* use CodeBlocks * use CodeBlocks
* or receive golden cookies if you get Cmake to work * or receive golden cookies if you get Cmake to work
Build system is not set in stone. Build system is not set in stone.
## TODO LIST
TODO LIST
* UI that doesn't suck * UI that doesn't suck
* better sound emulation * better sound emulation
* emulating some fancy addons * emulating some fancy addons
* other non-core shit (debugger, graphics viewers, cheat crapo, etc) * other non-core shit (debugger, graphics viewers, cheat crapo, etc)
### TODO LIST FOR LATER
TODO LIST FOR LATER
* hardware renderer for 3D (w/ upscaling and fancy shit) * hardware renderer for 3D (w/ upscaling and fancy shit)
* better wifi * better wifi
@ -60,8 +60,7 @@ TODO LIST FOR LATER
* LCD refresh time (used by some games for blending effects) * LCD refresh time (used by some games for blending effects)
* any feature you can eventually ask for that isn't outright stupid * any feature you can eventually ask for that isn't outright stupid
## Credits
CREDITS
* Martin for GBAtek, a good piece of documentation * Martin for GBAtek, a good piece of documentation
* Cydrak for the extra 3D GPU research * Cydrak for the extra 3D GPU research