Skip to content

Commit a2ce44d

Browse files
committed
Prepare for release on Github
- add README.md Signed-off-by: Tauwasser <[email protected]>
1 parent e9983d6 commit a2ce44d

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Interface for Nintendo® Game Boy® Cartridges
2+
3+
This is the host software for the Game Boy Cart Flasher, which was originally developed during 2005–2007 by
4+
Polish Game Boy enthusiasts Kraku & Chroost.
5+
6+
For a reimplementation of the microcontroller firmware for the USB model in the C programming language,
7+
check out the master branch *master*.
8+
9+
For information on the hardware and original firmware images, check out the hardware branch
10+
*hardware*.
11+
12+
## Features
13+
14+
The Game Boy Cart Flasher is an ATmega8515 MCU which interfaces which either USB or RS-232 and a
15+
GB Game Edge Connector (GEC) Receptacle (REC) to communicate both ways. It can read ROM, read/write
16+
SRAM, and read/write commonly available FLASH chips.
17+
18+
The ATmega8515 communicates using UART either directly via a MAX232 RS-232 driver/receiver or via
19+
FTDI's FT232 USB 2.0 FS bridge IC. The ATmega8515 is clocked at 6 MHz.
20+
21+
This reimplemented firmware only supports the USB version of GB Cart Flasher.
22+
23+
## Compilation
24+
25+
Use QTCreator with qmake to compile this project.
26+
27+
## Licensing
28+
29+
This host software is licensed under the GNU General Public Licence Version 2, or any later version, at the licensee's option.
30+
(SPDX-License-Identifier: GPL-2.0-or-later). See COPYING for a full text of the license.
31+
32+
```
33+
This program 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 2 of the License, or (at your option) any later version.
34+
35+
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
36+
37+
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
38+
```
39+
40+
## Legalese
41+
42+
I'm not affiliated with Nintendo in any way. Neither are Kraku or Chroost.
43+
44+
Game Boy® is a registered trademark by Nintendo. Nintendo® is a registered trademark.
45+
All other trademarks are property of their respective owner.

0 commit comments

Comments
 (0)