apple2ix/README.md

Apple //ix
==========

Apple2ix is an Apple //e (8bit 65c02 CPU) emulator designed to work on various POSIX platforms.

Lineage
-------

Apple2ix derives from the apple2-emul-linux project originally coded by various developers in the mid 1990's and FTP-uploaded as source tarballs to the original `tsx-11.mit.edu` Linux archive.

The original software was designed to work from the Linux console rendering via SVGAlib.  It ran on par to the 1MHz Apple //e on an i386 (Pentium 100 class) or better machine.  Later ports added X11 graphics support based on the original X11 DOOM source code drop, ty JC!

As of October 2016, the resurrected Apple2ix runs on x86 and ARM Android devices, x64 macOS 10.9+, and x64 GNU/Linux

Project Goals
-------------

* Portability and code resilience across a wide range of modern POSIXy systems including macOS, desktop Linux/BSD, iOS, Android. *If you are on Windows, just use the excellent [AppleWin](https://github.com/AppleWin/AppleWin) emulator!*
* Language/platform/API minimalism for core emulation modules (prefer coding to POSIX APIs and using C99 over all other choices)
* Reasonable emulation fidelity to the original Apple //e machine (timing, video, audio, etc...)
* Good platform citizenship for each port (prefer coding in language-of-choice promoted by platform--e.g.: Objective-C/Swift on Darwin, Java on Android, ...)

Project Tech
------------

* C99 dialect of the C programming language for the majority of the project
* x86 and ARM assembly language for 65c02 CPU emulation loop
* Extensive tests for 65c02 CPU, Apple //e VM, disks, and display (expected framebuffer output)
* OpenGLES 2.x graphics with simple portable GLSL shaders
* OpenAL and OpenSLES audio (emulated speaker and emulated Mockingboard/Phasor soundcards)
* Objective-C and Cocoa APIs (Mac/iOS variant)
* Java and Android APIs (Android app)

Maintained Ports
----------------

* Android 4.0+ (Android Studio & NDK build)
* Desktop GNU/Linux (GNU tools build)
* macOS/iOS (Xcode build)

Published Android App
---------------------

[Available on Google Play](https://play.google.com/store/apps/details?id=org.deadc0de.apple2ix.basic).

Running at 60FPS on Android 4.0+ devices:
![Apple2ix on Nexus 6](https://raw.github.com/mauiaaron/apple2/develop/docs/android-nexus6.png "Apple //ix")

Semi-Ordered TODO
-----------------

* Emulation feature implementations ... (mouse, printer, 3.5" disk, AppleHD, Phasor, ethernet?, ...)
* OS Ports : Net/Open/Free-BSD ports
* CPU arch ports: aarch64, RISC-V, Clang IR (bitcode)
* Port to web assembly

![DOS 3.3](https://raw.github.com/mauiaaron/apple2/master/docs/DOS33.png "DOS 3.3 Applesoft BASIC and //e monitor")
Updated README.md 2013-12-14 18:49:15 +00:00			`Apple //ix`
			`==========`

Fix typo 2016-07-09 17:51:17 +00:00			`Apple2ix is an Apple //e (8bit 65c02 CPU) emulator designed to work on various POSIX platforms.`
Update README.md 2016-01-09 21:43:08 +00:00
Update README.md 2015-03-13 07:14:44 +00:00			`Lineage`
			`-------`

			Apple2ix derives from the apple2-emul-linux project originally coded by various developers in the mid 1990's and FTP-uploaded as source tarballs to the original `tsx-11.mit.edu` Linux archive.

			`The original software was designed to work from the Linux console rendering via SVGAlib. It ran on par to the 1MHz Apple //e on an i386 (Pentium 100 class) or better machine. Later ports added X11 graphics support based on the original X11 DOOM source code drop, ty JC!`

Update README.md 2018-11-21 21:02:21 +00:00			`As of October 2016, the resurrected Apple2ix runs on x86 and ARM Android devices, x64 macOS 10.9+, and x64 GNU/Linux`
Updated README.md 2013-12-14 18:49:15 +00:00
			`Project Goals`
			`-------------`

Update README.md 2018-11-21 21:02:21 +00:00			`* Portability and code resilience across a wide range of modern POSIXy systems including macOS, desktop Linux/BSD, iOS, Android. If you are on Windows, just use the excellent [AppleWin](https://github.com/AppleWin/AppleWin) emulator!`
Update various copy 2016-06-26 16:55:13 +00:00			`* Language/platform/API minimalism for core emulation modules (prefer coding to POSIX APIs and using C99 over all other choices)`
Update README.md 2015-03-13 07:14:44 +00:00			`* Reasonable emulation fidelity to the original Apple //e machine (timing, video, audio, etc...)`
Update various copy 2016-06-26 16:55:13 +00:00			`* Good platform citizenship for each port (prefer coding in language-of-choice promoted by platform--e.g.: Objective-C/Swift on Darwin, Java on Android, ...)`

			`Project Tech`
			`------------`

			`* C99 dialect of the C programming language for the majority of the project`
			`* x86 and ARM assembly language for 65c02 CPU emulation loop`
			`* Extensive tests for 65c02 CPU, Apple //e VM, disks, and display (expected framebuffer output)`
			`* OpenGLES 2.x graphics with simple portable GLSL shaders`
			`* OpenAL and OpenSLES audio (emulated speaker and emulated Mockingboard/Phasor soundcards)`
			`* Objective-C and Cocoa APIs (Mac/iOS variant)`
			`* Java and Android APIs (Android app)`
Tweak dox 2015-04-12 23:14:04 +00:00
Update README.md 2018-11-21 21:02:21 +00:00			`Maintained Ports`
			`----------------`
Tweak dox 2015-04-12 23:14:04 +00:00
Update README.md 2018-11-21 21:02:21 +00:00			`* Android 4.0+ (Android Studio & NDK build)`
			`* Desktop GNU/Linux (GNU tools build)`
			`* macOS/iOS (Xcode build)`
Tweak dox 2015-04-12 23:14:04 +00:00
Update README.md 2018-11-21 21:02:21 +00:00			`Published Android App`
			`---------------------`
Updated github README 2014-12-07 21:41:00 +00:00
Update README.md 2018-11-21 21:02:21 +00:00			`[Available on Google Play](https://play.google.com/store/apps/details?id=org.deadc0de.apple2ix.basic).`
Updated github README 2014-12-07 21:41:00 +00:00
Update README.md 2018-11-21 21:02:21 +00:00			`Running at 60FPS on Android 4.0+ devices:`
			`![Apple2ix on Nexus 6](https://raw.github.com/mauiaaron/apple2/develop/docs/android-nexus6.png "Apple //ix")`
Show Mac screenshot 2014-12-07 22:14:25 +00:00
Updated README.md 2013-12-14 18:49:15 +00:00			`Semi-Ordered TODO`
			`-----------------`

Update README.md 2018-11-21 21:02:21 +00:00			`* Emulation feature implementations ... (mouse, printer, 3.5" disk, AppleHD, Phasor, ethernet?, ...)`
			`* OS Ports : Net/Open/Free-BSD ports`
			`* CPU arch ports: aarch64, RISC-V, Clang IR (bitcode)`
Update README.md 2018-07-30 02:00:30 +00:00			`* Port to web assembly`
Update README.md 2016-01-09 21:43:08 +00:00
			`![DOS 3.3](https://raw.github.com/mauiaaron/apple2/master/docs/DOS33.png "DOS 3.3 Applesoft BASIC and //e monitor")`
Update README.md 2016-10-27 04:31:42 +00:00