diff --git a/README.md b/README.md new file mode 100644 index 0000000..8e5cf7c --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# Cassette Player + +Simple HTML/JS/CSS Cassette Player + +## Instructions for hosting + +1. Clone or download this repository. + a. if downloading as a zip file, extract to a temporary folder +2. Copy or move the relevant files to the location you want to host them from. + i. `index.html` - main HTML file + ii. `app.js` - main app JavaScript file + iii. `styles.css` - app styling CSS file + iv. `background.png` - image for player background +3. Navigate to `http:///path/to/where/you/saved/index.html` in your browser. + +### Alternatively, if just previewing + +1. Unzip to a temporary folder. +2. Open `index.html` in your browser. (`ctrl/cmd+o`, drag and drop, etc.) + a. or navigate to the file manually in your address bar (e.g. `file:///Users/username/tempfolder/cassette-player/index.html`) \ No newline at end of file