Skip to content

Commit 55704ae

Browse files
author
BuildTools
committed
README.md Added Examples
1 parent 71abd66 commit 55704ae

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

README.md

+24-1
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,33 @@
2626

2727
## Installation
2828

29-
1. Clone the repository.
29+
- To install for Users:
30+
1. Download `MagicMonitor.html` from above.
3031
2. Open the `MagicMonitor.html` file in your preferred browser.
3132
3. Connect your USB device for console input.
3233

34+
- To install Standalone for Developers
35+
1. Clone the repository
36+
2. `mv MagicMonitor/CodeSplitting/testMagicMonitor MagicMonitor/index.html`
37+
3. `mv MagicMonitor/JS/testMagicMonitor MagicMonitor/JS/main.js`
38+
4. `rm MagicMonitor.html README.md` -(optional, but recommended)
39+
5. In your new `index.html`
40+
41+
- Locate
42+
```HTML
43+
<link rel="stylesheet" href="./CSS/MM.css">
44+
<script type="module" src="./JS/MagicMonitor.js" ></script>
45+
<script type="module" src="./JS/testMagicMonitor.js" ></script>
46+
```
47+
48+
- Modify
49+
```HTML
50+
<link rel="stylesheet" href="./CodeSplitting/CSS/MM.css">
51+
<script type="module" src="./CodeSplitting/JS/MagicMonitor.js" ></script>
52+
<script type="module" src="./CodeSplitting/JS/testMagicMonitor.js" ></script>
53+
```
54+
6. Code examples can be found below should you wish to only use `MagicMonitor.js` as a Code Snippet.
55+
3356
## Usage
3457

3558
1. Run the `MagicMonitor.html` file in your browser.

0 commit comments

Comments
 (0)