Add README.

1 files changed, 64 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..b5ce2b3
--- /dev/null
+++ b/README
@@ -0,0 +1,64 @@
+fujinet-updater - download and flash the firmware on a FujiNet device.
+
+This is an alternative to the fujinet-flasher[1] and
+fujinet_firmware_uploader.py[2] FujiNet flash updaters.
+
+It's written in Perl, has few dependencies, and should be easily
+portable to any vaguely UNIXish system. It can download the
+firmware from the fujinet-firmware github repo, or it can use
+already-downloaded firmware (zip file or extracted directory).
+
+Requirements:
+
+- A FujiNet. I've only tested with the FujiNet for the Atari, but
+  in theory this should work fine for the other FujiNet platforms
+  (apple2, adam, coco, etc). Also a USB cable that can connect the
+  FujiNet to the computer you run fujinet-updater on (which might
+  be micro USB or USB-C, depending on the age of the hardware).
+
+- perl, of course. Also the JSON and Getopt::Std modules, which are
+  bundled with the perl source, though on your OS they may be
+  provided separately from the main perl package.
+
+- unzip, for extracting the firmware (since it's distributed as
+  .zip files). Again, your OS should have this as a package already.
+
+- wget or curl, for downloading firmware. Your OS should provide
+  packages of these already. You could actually do without these,
+  if you're willing to download the firmware .zip files yourself.
+  You don't really need both; either one will do.
+
+- esptool.py, for actually flashing the firmware. See:
+  https://github.com/espressif/esptool
+  ...or your OS may provide a package for this. I'm not sure
+  what the minimum version is. I've tested this with 4.4, which
+  is pretty old (November 2021). If you have trouble with other
+  versions, please let me know.
+
+- pio (from PlatformIO), for viewing the FujiNet's debug log after
+  it's been flashed (this is optional but highly recommended). See:
+  https://platformio.org/
+  ...or your OS may provide a package for this.
+
+Installation:
+
+It's not really necessary (fujinet-updater can run from wherever
+you downloaded it to), but, something like this:
+
+  # install -o root -g root -m 0755 fujinet-updater /usr/bin
+  # fujinet-updater --man > /usr/man/man1/fujinet-updater.1
+
+On your OS, /usr/man/man1 might be /usr/share/man/man1 instead.
+Also you might prefer to install to /usr/local/{bin,man}. Up to you.
+
+Further Reading: perl fujinet-updater --help
+
+Author: B. Watson <urchlay@slackware.uk>
+
+License: WTFPL. Do WTF you want with this.
+
+Notes:
+
+[1] - https://github.com/FujiNetWIFI/fujinet-flasher
+[2] - Included in the main fujinet-firmware repo:
+      https://github.com/FujiNetWIFI/fujinet-firmware/