From 96947610fb64226e8217303834917da799f23d89 Mon Sep 17 00:00:00 2001 From: "Christopher A. Mosher" Date: Wed, 2 Nov 2022 21:41:55 -0400 Subject: [PATCH] improve readme --- README.md | 28 ++++++++++++++++++++-------- 1 file changed, 20 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 5c8ca31..135e264 100644 --- a/README.md +++ b/README.md @@ -2,19 +2,31 @@ Copyright © 2008–2019, Christopher Alan Mosher, Shelton, Connecticut, USA, . [GPLv3](https://www.gnu.org/licenses/gpl.md). +[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=CVSSQ2BWDCKQ2) [![Website](https://img.shields.io/website/https/cmosher01.github.io/Epple-II.svg)](https://cmosher01.github.io/Epple-II) [![Latest Release](https://img.shields.io/github/release/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) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](./code-of-conduct.md) -[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=CVSSQ2BWDCKQ2) -`epple2` is an emulator of the **Apple ][** and **Apple ][ plus** -computers from Apple, Inc. +See file [`LICENSE.other`](LICENSE.other) for additional copyright notices. + +Please note this project is released with a Contributor Code of Conduct. By +participating in this project you agree to abide by its terms. --- +## overview +`epple2` is an emulator of the **Apple \]\[** and **Apple \]\[ plus** +computers from Apple, Inc. -See files `COPYING.*` for other copyright notices. +## installation +[Download the release](https://github.com/cmosher01/Epple-II/releases/latest) for your +platform (`zip` for Windows, `deb` for Ubuntu, `pkg` for MacOS) and install as follows: -Please note that this project is released with a Contributor -Code of Conduct. By participating in this project you agree -to abide by its terms. +#### Ubuntu +`$ sudo apt install epple2_X.X.X_amd64.deb` + +#### MacOS +Double-click the `epple2.pkg` file and follow the instructions. + +#### Windows +Double-click the `epple2-windows.zip` file. Drag the `epple2` folder into the +`C:\Program Files (x86)\` folder. Double-click the `epple2` application to launch.