Skip to content

Commit 5eac2fa

Browse files
authored
Add README notes
1 parent 7ef4d03 commit 5eac2fa

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,29 @@
11
# Kiwi    [![Travis](https://img.shields.io/travis/drx/kiwi.svg)](https://travis-ci.org/drx/kiwi) [![Coveralls](https://img.shields.io/coveralls/drx/kiwi.svg)](https://coveralls.io/github/drx/kiwi)
22

3-
4-
53
Kiwi is a simple Sega Genesis emulator.
64

75
<table><tr><td align="center"><img src="/images/kiwi.gif?raw=true"><br>Kiwi in action</td></tr></table>
86

9-
## Quick start
7+
### Quick start
108

119
1. `git clone git://github.com/drx/kiwi.git` or [download the latest version](https://github.com/drx/kiwi/zipball/master)
1210
2. `$ brew install qt@4` (macOS)<br>`$ sudo apt-get install libqt4-dev` (Linux)
1311
2. `$ pip install PySide`
1412
2. `$ make`
1513
3. `$ ./kiwi.py`
1614

17-
## Requirements
15+
### Requirements
1816

1917
* clang/gcc, make, Python 2.7
2018
* Qt 4, PySide
2119

22-
## Acknowledgements
20+
### Acknowledgements
2321

2422
* The [hqx library](http://code.google.com/p/hqx/) is by Maxim Stepin and Cameron Zemek
2523
* The Musashi library is by Karl Stenerud
24+
25+
### Notes
26+
27+
* Kiwi was written in 2013, with some bugs fixed and tests added more recently.
28+
* There is no sound support. The Z80 processor is handled by dummy code. Some games do not work at all because of this.
29+
* Tested on Linux and macOS.

0 commit comments

Comments
 (0)