Initial preparation for a release

dingusdev · Apr 15, 2024 · 8cbbb2e · 8cbbb2e
1 parent 781d9b4
commit 8cbbb2e
Show file tree

Hide file tree

Showing 21 changed files with 82 additions and 4 deletions.
diff --git a/CREDITS.md b/CREDITS.md
@@ -0,0 +1,32 @@
+# DingusPPC
+
+
+## Developers
+
+- divingkatae
+- maximumspatium
+- joevt
+- mihaip
+
+## Building
+
+- Waqar144
+- webspacecreations
+- leap0x7b
+- sdkmap
+
+## Testing
+
+- LagLifeYT
+
+## Thanks
+
+- 68kmla
+- AppleFritter
+- Archive.org
+- Bitsavers
+- Emaculation
+- GitHub
+- PenguinPPC
+- The developers of other PowerPC Mac emulators, past and present
+- All those preserving the software of 68k and PowerPC Macs
diff --git a/icon.png b/icon.png
diff --git a/main.cpp b/main.cpp
@@ -53,10 +53,11 @@ void sigabrt_handler(int signum) {
 }
 
 static string appDescription = string(
-    "\nDingusPPC - Prototype 5bf5 (8/23/2020)       "
-    "\nWritten by divingkatae and maximumspatium    "
-    "\n(c) 2018-2020 The DingusPPC Dev Team.        "
-    "\nThis is not intended for general use.        "
+    "\nDingusPPC - Alpha 1 (5/10/2024)              "
+    "\nWritten by divingkatae, maximumspatium,      "
+    "\njoevt, mihaip, et. al.                       "
+    "\n(c) 2018-2024 The DingusPPC Dev Team.        "
+    "\nThis is a build intended for testing.        "
     "\nUse at your own discretion.                  "
     "\n"
 );

diff --git a/zdocs/aboutthis.md → zdocs/developers/aboutthis.md b/zdocs/aboutthis.md → zdocs/developers/aboutthis.md
diff --git a/zdocs/adb.md → zdocs/developers/adb.md b/zdocs/adb.md → zdocs/developers/adb.md
diff --git a/zdocs/atirage.md → zdocs/developers/atirage.md b/zdocs/atirage.md → zdocs/developers/atirage.md
diff --git a/zdocs/awacs.md → zdocs/developers/awacs.md b/zdocs/awacs.md → zdocs/developers/awacs.md
diff --git a/zdocs/bmac.md → zdocs/developers/bmac.md b/zdocs/bmac.md → zdocs/developers/bmac.md
diff --git a/zdocs/cpu/powerpc/mmu.md → zdocs/developers/cpu/powerpc/mmu.md b/zdocs/cpu/powerpc/mmu.md → zdocs/developers/cpu/powerpc/mmu.md
diff --git a/zdocs/cpu/powerpc/mmuemu.md → zdocs/developers/cpu/powerpc/mmuemu.md b/zdocs/cpu/powerpc/mmuemu.md → zdocs/developers/cpu/powerpc/mmuemu.md
diff --git a/zdocs/get-inherited-property notes.txt → ...velopers/get-inherited-property notes.txt b/zdocs/get-inherited-property notes.txt → ...velopers/get-inherited-property notes.txt
diff --git a/zdocs/grackle.md → zdocs/developers/grackle.md b/zdocs/grackle.md → zdocs/developers/grackle.md
diff --git a/zdocs/heathrow.md → zdocs/developers/heathrow.md b/zdocs/heathrow.md → zdocs/developers/heathrow.md
diff --git a/zdocs/machines/pdmram.md → zdocs/developers/machines/pdmram.md b/zdocs/machines/pdmram.md → zdocs/developers/machines/pdmram.md
diff --git a/zdocs/memorymaps.md → zdocs/developers/memorymaps.md b/zdocs/memorymaps.md → zdocs/developers/memorymaps.md
diff --git a/zdocs/mesh.md → zdocs/developers/mesh.md b/zdocs/mesh.md → zdocs/developers/mesh.md
diff --git a/zdocs/misc.md → zdocs/developers/misc.md b/zdocs/misc.md → zdocs/developers/misc.md
diff --git a/zdocs/openfirmware.md → zdocs/developers/openfirmware.md b/zdocs/openfirmware.md → zdocs/developers/openfirmware.md
diff --git a/zdocs/powerpc.md → zdocs/developers/powerpc.md b/zdocs/powerpc.md → zdocs/developers/powerpc.md
diff --git a/zdocs/viacuda.md → zdocs/developers/viacuda.md b/zdocs/viacuda.md → zdocs/developers/viacuda.md
diff --git a/zdocs/users/manual.md b/zdocs/users/manual.md
@@ -0,0 +1,45 @@
+# DingusPPC User Manual
+
+## Commands
+
+DingusPPC is operated using the command line interface. As such, we will list the commands as required.
+
+```
+-r, --realtime
+```
+
+Run the emulator in runtime.
+
+```
+-d, --debugger
+```
+
+Enter the interactive debugger. The user may also enter the debugger at any point by pressing Control and C.
+
+```
+list machines
+```
+
+Shows the currently implemented machines within DingusPPC.
+
+```
+list properties
+```
+
+Shows the configurable properties, such as the selected disc image and the ram bank sizes.
+
+## Supported machines
+
+The machines that currently work the best are the Power Mac 6100, the Power Mac 7500, and the Power Mac G3.
+
+Early implementations for the Power Mac G3 Blue and White and the Apple Pippin are also present.
+
+## Quirks
+
+### CD ROM Images
+
+Currently, ISO images are supported. However, support is not yet implemented for multi-mode CD images.
+
+### Hard Disks
+
+Because Sheepshaver, Basilisk II, and Mini vMac operate on raw disks, it is required to a program such as BlueSCSI to make their hard disk images work in an emulator like DingusPPC.