Skip to content

Commit 2029baa

Browse files
committed
Updated README to reflect the new Maven modules.
1 parent a35016a commit 2029baa

1 file changed

Lines changed: 12 additions & 4 deletions

File tree

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The emulator can be build with [Maven](https://maven.apache.org/):
1010

1111
mvn clean package
1212

13-
The coffee-gb-*-complete.jar executable file will be available in the `./target` directory.
13+
The coffee-gb-*.jar executable file will be available in the `./swing/target` directory.
1414

1515
## Usage
1616

@@ -32,12 +32,20 @@ Play with <kbd>&larr;</kbd>, <kbd>&uarr;</kbd>, <kbd>&darr;</kbd>, <kbd>&rarr;</
3232
* Support for zipped ROMs
3333
* ROM-based compatibility tests run from Maven
3434

35+
## Modules
36+
37+
Emulator is split into modules:
38+
39+
* core - the core emulator. This module can be easily referenced from other projects.
40+
* swing - the desktop UI with executable.
41+
* controller - the middleware between the UI and the core. It also contains network support.
42+
3543
## Running Blargg's tests
3644

3745
The [Blargg's test ROMs](http://gbdev.gg8.se/wiki/articles/Test_ROMs) are used for testing the compatibility. Tests can be launched from Maven using appropriate profile:
3846

39-
mvn clean test -Ptest-blargg
40-
mvn clean test -Ptest-blargg-individual # for running "single" tests providing more diagnostic info
47+
mvn clean test -f core/pom.xml -Ptest-blargg
48+
mvn clean test -f core/pom.xml -Ptest-blargg-individual # for running "single" tests providing more diagnostic info
4149

4250
They are also part of the [Travis-based CI](https://travis-ci.org/trekawek/coffee-gb).
4351

@@ -66,7 +74,7 @@ Coffee GB passes all the tests:
6674

6775
The [Mooneye GB](https://github.com/Gekkio/mooneye-gb) emulator comes with a great set of test ROMs. They can be used to test the Coffee GB as well. Use -Ptest-mooneye profile:
6876

69-
mvn clean test -Ptest-mooneye
77+
mvn clean test -f core/pom.xml -Ptest-mooneye
7078

7179
## Screenshots
7280

0 commit comments

Comments
 (0)