revamp readme file, markdown

This commit is contained in:
Christopher A. Mosher 2019-04-07 23:32:11 -04:00
parent 0313881ac0
commit cb386609f3
4 changed files with 50 additions and 36 deletions

View File

@ -74,7 +74,7 @@ RUN make install 2>&1 | tee -a $BUILD_LOG
# supervisor
RUN rm -R /etc/supervisor/*
ENTRYPOINT ["supervisord"]
CMD ["-c", "both"]
CMD ["-c", "app"]
COPY supervisor/includes /etc/supervisor/
COPY supervisor/commands ./

1
README
View File

@ -1 +0,0 @@
README.asciidoc

View File

@ -1,34 +0,0 @@
epple2 (Emulated Apple ][)
==========================
Christopher A. Mosher <cmosher01@gmail.com>
image:https://travis-ci.org/cmosher01/Epple-II.svg?branch=master["Build Status", link="https://travis-ci.org/cmosher01/Epple-II"]
Home page: http://mosher.mine.nu/epple2[]
+epple2+ is an emulator of the *Apple ][* and *Apple ][ plus*
computers from Apple, Inc. It strives to faithfully simulate
much of the internal workings of the original Apple ][,
including the individual cycles of the 6502 CPU, and the
NTSC video signal generation, including the ``strange orange
line'', other color anomalies, and the ``floating data bus.''
_Understanding the Apple ][_, by Jim Sather, is the primary
source for information about the internals of the Apple ][.
The CPU and video timings are synchronized, and the emulator
is designed to run at the same speed as the original
machine (if your computer is fast enough). It also emulates
several different types of television screens and monitors
for the display.
It includes emulation of a Disk ][ controller card, a ROM
firmware card, and a RAM Language card, as well as a
simple clock card.
+epple2+ is written in C++, and is designed to be buildable
on Linux, Mac, or Windows (mingw). http://www.libsdl.org/[SDL]
is the only dependency.
+epple2+ is released under GPLv3.
See files +COPYING.*+ for copyright notices.

49
README.md Normal file
View File

@ -0,0 +1,49 @@
# epple2, The Emulated Apple ][
Copyright © 20082019, Christopher Alan Mosher, Shelton, Connecticut, USA, <cmosher01@gmail.com>.
[![License](https://img.shields.io/github/license/cmosher01/Epple-II.svg)](https://www.gnu.org/licenses/gpl.html)
[![Latest Release](https://img.shields.io/github/release-pre/cmosher01/Epple-II.svg)](https://github.com/cmosher01/Epple-II/releases/latest)
[![Build Status](https://travis-ci.com/cmosher01/Epple-II.svg?branch=master)](https://travis-ci.com/cmosher01/Epple-II)
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=CVSSQ2BWDCKQ2)
Home page: <https://mosher.mine.nu/epple2>
`epple2` is an emulator of the **Apple ][** and **Apple ][ plus**
computers from Apple, Inc.
---
The fundamental principle of `epple2` is to accurately and faithfully
emulate the behavior of the original Apple ][ machines, including the
internal workings, as much as practical.
Features of the emulation include:
* individual cycles of the 6502 CPU
* NTSC video signal generation
* displaying the *strange orange line*
* other display color anomalies
* floating data bus
* Disk ][ Logic State Sequencer
* read copy-protected disks
* read/write half- and quarter-tracks
* configurable RAM chips
* cassette tape interface
The CPU and video timings are synchronized, and the emulator
is designed to run at the same speed as the original
machine (about 1MHz). It also emulates a television screen,
and color and monochrome monitors, for the display.
It includes emulation of the **Disk ][** controller card,
the ROM firmware card, and the RAM Language Card, as well
as a simple clock card.
The primary source for information about the internals of the
Apple ][ is *Understanding the Apple ][*, by Jim Sather.
`epple2` is written in C++, and is designed to be buildable
on Linux, Mac, or Windows (mingw).
[SDL](http://www.libsdl.org/) is the only dependency.
See files `COPYING.*` for other copyright notices.