README.txt: renamed from README, tweaked.

1 files changed, 91 insertions, 0 deletions

diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..76003f8
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,91 @@
+This is a collection of Atari 8-bit related utilities I've written for
+or ported to Linux. They should be usable as-is on other UNIX-like
+systems, including Cygwin for MS-Windows.
+
+a8eol      - Convert Atari 8-bit text files to/from UNIX / DOS / Mac Classic
+             text file format.
+
+a8utf8     - Convert Atari 8-bit text to UTF-8 encoded Unicode.
+
+axe        - ATR/XFD Editor. Copy files into & out of ATR and XFD images,
+             create blank ATR images, etc.
+
+atr2xfd    - Convert an Atari 8-bit ATR disk image to a raw (XFD) image.
+
+atrcheck   - Check an Atari 8-bit ATR disk image for various types of problems.
+
+atrsize    - Change the size of an Atari 8-bit ATR disk image, or create
+             a blank ATR image.
+
+blob2c     - Create C source and header files from a binary file.
+
+blob2xex   - Create a XEX file from arbitrary data.
+
+cart2rom   - Convert an Atari800 CART image to a raw ROM image.
+
+cart2xex   - Convert an Atari 8-bit ROM cartridge image to a binary load
+             (XEX) file.
+
+dasm2atasm - Convert 6502 assembly in DASM syntax to ATASM (or MAC/65) format.
+
+fenders    - Install Fenders 3-sector loader in boot sectors of an ATR image.
+
+rom2cart   - Convert a raw Atari 8-bit cartridge ROM image to a CART
+             image for use with emulators such as Atari800.
+
+unmac65    - Detokenize Atari 8-bit Mac/65 SAVEd files.
+
+unprotbas  - Unprotect LIST-protected BASIC programs.
+
+xex1to2    - Convert an Atari DOS 1.0 executable into a standard XEX file.
+
+xexamine   - Show information on XEX files.
+
+xexcat     - Concatenate Atari 8-bit executables (XEX) into a single XEX file.
+
+xexsplit   - Split a multi-segment Atari 8-bit executable (XEX) into
+             multiple single-segment files.
+
+xfd2atr    - Convert an Atari 8-bit XFD (raw) disk image to an ATR image.
+
+All are written in C, except a8utf8 and dasm2atasm which are written
+in Perl. All utilities have man pages.
+
+Also included is "equates.inc", a 6502 assembly header file that defines
+the Atari 8-bit system equates. It's meant to be used with either the
+DASM or ATASM 6502 cross assemblers.
+
+Also included: collections of utilities by Ken Siders and Jindrich
+Kubec. See the README.txt files in the  ksiders/ and jindroush/
+directories for details.
+
+To install, use the standard "make && make install" process. The default
+prefix for installation is /usr/local.
+
+You may use "make install PREFIX=/somewhere/else" to install somewhere
+other than /usr/local. Binaries will be installed to $PREFIX/bin, man
+pages to $PREFIX/share/man/man1, and other documentation (including
+equates.inc) to $PREFIX/share/doc/bw-atari8-tools. You also may use
+BINDIR, MANDIR, MAN1DIR, and DOCDIR to explicitly set the installation
+paths. Man pages are compressed with gzip by default. If your system
+does not support gzipped man pages, try "make install GZIP_MAN=n". If
+you're creating a distribution package (RPM, deb, Slackware tgz),
+use "make install PREFIX=/usr DESTDIR=/tmp/whatever". This will
+build everything for use in /usr, but actually install everything to
+/tmp/whatever/usr, which can then be archived in whichever package
+format you're using.
+
+blob2c is not actually Atari-specific: it could be useful for any project
+where the contents of a file need to be compiled as an unsigned char
+array in a C program.
+
+dasm2atasm is not Atari-specific, since the DASM and ATASM cross
+assemblers can be used to develop code for any 6502-based platform
+(though ATASM does have some nice extra features for the Atari 8-bit).
+DASM supports several other CPUs besides the 6502, but dasm2atasm only
+works with 6502 code.
+
+The latest version of bw-atari8-tools can always be found at
+https://slackware.uk/~urchlay/repos/bw-atari8-tools
+
+-- B. Watson <urchlay@slackware.uk>; Urchlay on irc.libera.chat ##atari.