Retro/pcjs
Watch
1
0
Fork
You've already forked pcjs
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Moved the PCx86 examples from /docs to /apps

Browse source
This commit is contained in:
Jeff Parsons 2017-09-18 19:44:47 -07:00 • committed by Jeff Parsons
commit 6818927e59
29 changed files with 41 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

17
pubs/docs/c1pjs/embed/README.md
View file

@ -12,7 +12,7 @@ redirect_from:
---
Embedding The C1Pjs Simulator
---
-----------------------------
{% include machine.html id="c1p8kb" %}
@ -36,7 +36,8 @@ Otherwise, read on to learn how embedding works, and how you can create your own
its appearance.
Step 1: Create a machine definition XML file
---
--------------------------------------------
You need an XML file that defines a Challenger configuration, listing all the components it will contain and where
they will be mapped into the address space.
@ -92,7 +93,8 @@ Want to embed *multiple* simulators on a single page? No problem. Each **<mac
a unique *id* attribute. Take a look at [array.xml](/devices/c1p/machine/8kb/array/) for an example.
Step 2: Make sure you have all the necessary resource files
---
-----------------------------------------------------------
In the above XML file, the ROM and Video components refer to additional resources:
- 8K BASIC ROM image @ http://www.pcjs.org/devices/c1p/rom/basic-gcpatch.hex
@ -126,7 +128,8 @@ such as samples.xml:
```
Step 3: Add the C1Pjs Simulator to your web page
---
------------------------------------------------
Somewhere on your page, you need to add the following **<script>** element:
```html
@ -158,7 +161,8 @@ paste it into your machine definition file, inside a pair of **<panel *id*="p
elements, or link to it using a single **<panel/>** element with the *ref* attribute.
Step 4: Activate the C1Pjs Simulator
---
------------------------------------
Add the following to your page's **<body>** element:
```html
@ -174,7 +178,8 @@ The **embedC1P()** function accepts three parameters:
parameter and use the default [XML stylesheet](/versions/c1pjs/1.34.0/components.xsl).
Step 5: Enjoy!
---
--------------
All I ask is that any page that embeds the simulator also includes attribution, such as:
> [PCjs](http://pcjs.org) © 2012-2017 by [Jeff Parsons](mailto:Jeff@pcjs.org) ([@jeffpar](http://twitter.com/jeffpar))