Add README for SyncFiles

GitOrigin-RevId: fc9eef02792debc4929a47830ac534d4c1c4515d

README.md

@@ -0,0 +1,51 @@
+# SyncFiles
+
+SyncFiles is a tool for MPW (Macintosh Programmer’s Workshop) which synchronizes files between a Macintosh and Unix system. It is used to copy files between a classic Macintosh development environment (e.g. MPW running on Mac System 7) and a modern Unix environment (e.g. a Basilisk II host system or an AppleShare volume).
+
+## What SyncFiles Does
+
+- By default, only copies files which are _newer_ than the destination file (unless `-force` is specified). This means that your classic Macintosh’s system should have the clock set correctly!
+
+- Sets the modification timestamp of the destination file to match the timestamp of the source file.
+
+- Only synchronizes files which match hard-coded patterns: copies the Makefile and any files matching `*.c`, `*.h`, or `*.r`.
+
+- Converts files to UTF-8 and LF line endings for Unix systems; converts to Mac OS Roman and CR line endings for Macintosh systems.
+
+- Creates Macintosh files with MPW Shell creator code and text file type.
+
+## Limitations
+
+There is a hard-coded maximum file size of 64 KiB.
+
+## Usage
+
+Operates in push or pull mode. The tool runs from inside the classic Macintosh environment, so the “push” mode copies from Macintosh to Unix, and the “pull” mode copies from Unix to Macintosh. It is assumed that the Macintosh directory is on a normal disk volume.
+
+### Basic Usage
+
+To push files from the current directory,
+
+```
+SyncFiles <DestPath> -push
+```
+
+To pull files from the current directory,
+
+```
+SyncFiles <DestPath> -pull
+```
+
+### Other Flags
+
+- `-verbose`: Print lots of boring messages.
+
+- `-quiet`: Print only errors and warnings.
+
+- `-force`: Ignore timestamps, copy all source files to destination.
+
+- `-dry-run`: Perform no actions, just print out what would be done.
+
+- `-dir`: Specify an alternat Macintosh directory to push from or pull to. By default, pushes from and pulls to the current directory.
+
+- `-delete`: Delete files in destination which are missing from source.