Redirect those who might peruse this repo

This commit is contained in:
elliotnunn 2023-06-02 13:01:34 +08:00 committed by GitHub
parent b1d95b5928
commit 4de6504b9c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 67 deletions

View File

@ -1,67 +1 @@
The PowerPC ROM for NewWorld Macs
=================================
This repo is part of the *CDG5* project. It builds a 4 MB PowerPC Mac ROM by appending PowerPC code to a 68k Mac ROM (either the included dump, [or one that you built yourself](https://github.com/elliotnunn/mac-rom)). The build result is a byte-perfect copy of the ROM inside the final "Mac OS ROM" release.
Fixing line endings
-------------------
MPW requires old-style Mac line endings (CR), while Git works better with Unix line endings (LF). Git filters can be used to convert between the two. Files committed to the repo are "cleaned" (LF-ed), and then "smudged" (CR-ed) when they hit the working tree. After cloning, append these snippets to your Git config.
Append this to `.git/config`:
[filter "maclines"]
clean = LC_CTYPE=C tr \\\\r \\\\n
smudge = LC_CTYPE=C tr \\\\n \\\\r
Append this to `.git/info/attributes`:
* filter=maclines
*.* -filter
*.s filter=maclines
*.a filter=maclines
*.c filter=maclines
*.h filter=maclines
Finally, do a once-off "re-smudge":
rm -rf ../powermac-rom/*
git checkout .
Setting type and creator codes
------------------------------
Some MPW Tools require their input files to have the correct Mac OS file type, but Git does not save Mac OS type and creator codes. This shell script will give enough files a "TEXT" type to keep MPW happy.
sh SetFileTypes.sh
Building
--------
This code is built with the [Macintosh Programmer's Workshop](https://en.wikipedia.org/wiki/Macintosh_Programmer%27s_Workshop) (MPW), which runs on the Classic Mac OS. To satisfy the memory requirements of the build process, the MPW Shell should get a memory partition of at least 16 MB. Once you have MPW set up, the build process is not particularly fussy.
Not many computers run the Classic Mac OS any more. Here are a few workarounds:
* Just find a Mac running Mac OS 7.5-9.2. (Not much fun if it's also your test machine.)
* Use the Classic environment on a PowerPC Mac running Mac OS X 10.4 or earlier. (A small PowerBook or iBook is perfect.)
* Use [EMPW](https://github.com/elliotnunn/empw) ("Emulated MPW"), a package of command-line tools, emulators and OS images that lets you run MPW commands straight from your macOS Terminal. This is my preferred solution.
Once MPW is set up, the build command is:
EasyBuild
Using EMPW, that's:
empw -b EasyBuild
Even nicer is this Unix shell script, which avoids unnecessary launches of the emulator:
./EasyBuild.sh
The 4 MB image will be at `BuildResults/PowerROM`.
Using a different 68k ROM image
-------------------------------
Clone https://github.com/elliotnunn/mac-rom next door to this repo, and uncomment the "Diving into mac-rom repo" lines in `EasyBuild.sh`
What's next?
------------
On NewWorld Macs, this image is extracted into RAM from a "Mac OS ROM" file at boot. Use https://github.com/elliotnunn/newworld-rom to build such a file.
Use https://github.com/elliotnunn/tbxi instead!