dingusppc/README.md

# DingusPPC by divingkatae

Be warned the program is highly unfinished and could use a lot of testing. Any feedback is welcome.

## PHILOSOPHY OF USE

Sheepshaver, while technically impressive, is becoming harder to compile and run. While many other PowerPC emus exist, none of them currently attempt emulation of PPC Macs (except for QEMU).

This program aims to not only improve upon what Sheepshaver has done, but also to provide a better debugging environment. This currently is designed to work best with PowerPC Old World ROMs,
including those of the PowerMac G3 Beige.

## HOW TO USE

This program currently uses the command prompt to work.

There are a few command line arguments one must enter when starting the program.

-realtime

Run the emulator in runtime.

-debugger

Enter the interactive debugger.

## HOW TO COMPILE

You'll need to install development tools first.

At least, a C++ compiler and [CMake](https://cmake.org) are required.

For example, to build the project in a Unix-like environment, you'll need to run
the following commands in the OS terminal:
```
mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Release ..
make dingusppc
```
You may specify another build type using the variable CMAKE_BUILD_TYPE.

Due to the incomplete status of the program at this time, no additional libraries are required.

Future versions will include SDL 2 as a requirement.

## Testing

DingusPPC includes a test suite for verifying the correctness of its PowerPC CPU
emulation. To build the tests, use the following terminal commands:
```
mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Release ..
make testppc
```

## Intended Minimum Requirements

- Windows 7 or newer (64-bit), Linux 4.4 or newer, Mac OS X 10.9 or newer (64-bit)
- Intel Core 2 Duo or better
- 2 GB of RAM
- 2 GB of Hard Disk Space
- Graphics Card with a minimum resolution of 800*600

## Compiler Requirements

- GCC 4.7 or newer (i.e. CodeBlocks 13.12 or newer)
- Visual Studio 2013 or newer
Create README.md 2019-07-02 02:19:08 +00:00			`# DingusPPC by divingkatae`

			`Be warned the program is highly unfinished and could use a lot of testing. Any feedback is welcome.`

			`## PHILOSOPHY OF USE`

Remove optimization options from CMakeLists.txt. Update the COMPILE section in the README. 2019-12-26 22:56:53 +00:00			`Sheepshaver, while technically impressive, is becoming harder to compile and run. While many other PowerPC emus exist, none of them currently attempt emulation of PPC Macs (except for QEMU).`

			`This program aims to not only improve upon what Sheepshaver has done, but also to provide a better debugging environment. This currently is designed to work best with PowerPC Old World ROMs,`
Create README.md 2019-07-02 02:19:08 +00:00			`including those of the PowerMac G3 Beige.`
Remove optimization options from CMakeLists.txt. Update the COMPILE section in the README. 2019-12-26 22:56:53 +00:00
Create README.md 2019-07-02 02:19:08 +00:00			`## HOW TO USE`

Restructure main.cpp, remove obsolete code. 2020-01-28 01:20:18 +00:00			`This program currently uses the command prompt to work.`
Create README.md 2019-07-02 02:19:08 +00:00
Restructure main.cpp, remove obsolete code. 2020-01-28 01:20:18 +00:00			`There are a few command line arguments one must enter when starting the program.`
Create README.md 2019-07-02 02:19:08 +00:00
			`-realtime`

Near-Midnight Update - July 18, 2019 - Added a check for NuBus Macs, providing a mirror to the ROM - Very slightly optimized ROM accesses for instructions and reads - Some slight OpenPIC fixes - Removed unused variables and slightly improved code readability - Changed readme + boot-up help to reflect on newly added debugger More changes will be added soon. 2019-07-19 06:31:16 +00:00			`Run the emulator in runtime.`
Create README.md 2019-07-02 02:19:08 +00:00
Near-Midnight Update - July 18, 2019 - Added a check for NuBus Macs, providing a mirror to the ROM - Very slightly optimized ROM accesses for instructions and reads - Some slight OpenPIC fixes - Removed unused variables and slightly improved code readability - Changed readme + boot-up help to reflect on newly added debugger More changes will be added soon. 2019-07-19 06:31:16 +00:00			`-debugger`
Create README.md 2019-07-02 02:19:08 +00:00
Near-Midnight Update - July 18, 2019 - Added a check for NuBus Macs, providing a mirror to the ROM - Very slightly optimized ROM accesses for instructions and reads - Some slight OpenPIC fixes - Removed unused variables and slightly improved code readability - Changed readme + boot-up help to reflect on newly added debugger More changes will be added soon. 2019-07-19 06:31:16 +00:00			`Enter the interactive debugger.`
Create README.md 2019-07-02 02:19:08 +00:00
Remove optimization options from CMakeLists.txt. Update the COMPILE section in the README. 2019-12-26 22:56:53 +00:00			`## HOW TO COMPILE`

			`You'll need to install development tools first.`

			`At least, a C++ compiler and [CMake](https://cmake.org) are required.`

			`For example, to build the project in a Unix-like environment, you'll need to run`
			`the following commands in the OS terminal:`
			```
			`mkdir build`
			`cd build`
			`cmake -DCMAKE_BUILD_TYPE=Release ..`
Make dingusppc and testppc independent targets. 2020-02-10 15:41:40 +00:00			`make dingusppc`
Remove optimization options from CMakeLists.txt. Update the COMPILE section in the README. 2019-12-26 22:56:53 +00:00			```
			`You may specify another build type using the variable CMAKE_BUILD_TYPE.`
Create README.md 2019-07-02 02:19:08 +00:00
			`Due to the incomplete status of the program at this time, no additional libraries are required.`
Remove optimization options from CMakeLists.txt. Update the COMPILE section in the README. 2019-12-26 22:56:53 +00:00
Create README.md 2019-07-02 02:19:08 +00:00			`Future versions will include SDL 2 as a requirement.`
Remove optimization options from CMakeLists.txt. Update the COMPILE section in the README. 2019-12-26 22:56:53 +00:00
Make dingusppc and testppc independent targets. 2020-02-10 15:41:40 +00:00			`## Testing`

			`DingusPPC includes a test suite for verifying the correctness of its PowerPC CPU`
			`emulation. To build the tests, use the following terminal commands:`
			```
			`mkdir build`
			`cd build`
			`cmake -DCMAKE_BUILD_TYPE=Release ..`
			`make testppc`
			```

Create README.md 2019-07-02 02:19:08 +00:00			`## Intended Minimum Requirements`
Remove optimization options from CMakeLists.txt. Update the COMPILE section in the README. 2019-12-26 22:56:53 +00:00
Create README.md 2019-07-02 02:19:08 +00:00			`- Windows 7 or newer (64-bit), Linux 4.4 or newer, Mac OS X 10.9 or newer (64-bit)`
			`- Intel Core 2 Duo or better`
Worked more on Grackle, ESCC, and OpenPIC 2019-07-15 00:05:10 +00:00			`- 2 GB of RAM`
			`- 2 GB of Hard Disk Space`
Create README.md 2019-07-02 02:19:08 +00:00			`- Graphics Card with a minimum resolution of 800*600`
Remove optimization options from CMakeLists.txt. Update the COMPILE section in the README. 2019-12-26 22:56:53 +00:00
Create README.md 2019-07-02 02:19:08 +00:00			`## Compiler Requirements`
Remove optimization options from CMakeLists.txt. Update the COMPILE section in the README. 2019-12-26 22:56:53 +00:00
Create README.md 2019-07-02 02:19:08 +00:00			`- GCC 4.7 or newer (i.e. CodeBlocks 13.12 or newer)`
			`- Visual Studio 2013 or newer`