Update to READMEs

This commit is contained in:
Jeff Parsons 2015-02-08 14:04:58 -08:00 committed by jeffpar
commit f9df384bbe
5 changed files with 39 additions and 16 deletions

View file

@ -12,6 +12,27 @@ information on [customizing and embedding](embed/) your own configurations.
### Using C1Pjs
> **NOTE:** For those of you who never used a *real* Challenger 1P machine, if any of the operational
details of the machine seem bizarre, that's not the simulator's fault. It's how the machine
actually operated.
> Some of those details are artifacts of teletype-based interfaces, which were more common
than a video monitor interface in the 1970's. On a teletype, there was no way to physically
erase printed characters, so you had to count underscores to know how many characters had been
erased internally.
> Also, the wide margins on either side of the screen were a side-effect of how the machine
displayed video on a conventional television set; they helped ensure that no characters would be
displayed off-screen and therefore unreadable. As a result, even though the machine contained
enough video memory for 32 rows of characters, each with 32 columns, the usable portion was much
smaller.
> The original C1P, with its more modern keyboard and video monitor interface, obviously could
have done a better job processing and displaying user input (and in fact, I wrote some
machine-language extensions back in the day that did exactly that). And Ohio Scientific did improve
later models, but the original C1P functioned exactly as shown, with all its teletype-like
idiosyncrasies and television-related limitations.
#### Starting the Simulator
> Press the **RUN** or **BREAK** button to start the C1Pjs Simulator.

View file

@ -6,13 +6,13 @@ If you want to read as little as possible, then just paste the following code on
<div id="myC1P"/></div><div style="clear:both"></div>
<script type="text/javascript"
src="http://www.pcjs.org/versions/c1pjs/1.15.3/c1p.js">
src="http://www.pcjs.org/versions/c1pjs/1.17.1/c1p.js">
</script>
<script type="text/javascript">
window.embedC1P(
"myC1P",
"http://www.pcjs.org/devices/c1p/machine/8kb/embed/machine.xml",
"http://www.pcjs.org/versions/c1pjs/1.15.3/components.xsl"
"http://www.pcjs.org/versions/c1pjs/1.17.1/components.xsl"
);
</script>
@ -28,7 +28,7 @@ The order of the XML elements also determines the layout of the associated HTML
**&lt;keyboard&gt;** element appears before the **&lt;video&gt;** element, then the keyboard controls will be
displayed *above* the video display instead of *below*. There's an extensive set of attributes that you can add
to any of the elements below to style and position them, including the usual *style* attribute, but at present,
there's no documentation beyond the sample XML files and the default [XML stylesheet](/versions/c1pjs/1.15.3/components.xsl).
there's no documentation beyond the sample XML files and the default [XML stylesheet](/versions/c1pjs/1.17.1/components.xsl).
The example at the top of this page uses an [XML file](/devices/c1p/machine/8kb/embed/machine.xml) that looks like:
@ -62,7 +62,7 @@ The example at the top of this page uses an [XML file](/devices/c1p/machine/8kb/
Machine configuration files can also be "self-starting" if they contain the following XML stylesheet reference at the
top of the file:
<?xml-stylesheet type="text/xsl" href="http://www.pcjs.org/versions/c1pjs/1.15.3/machine.xsl"?>
<?xml-stylesheet type="text/xsl" href="http://www.pcjs.org/versions/c1pjs/1.17.1/machine.xsl"?>
For example, here's a self-starting [machine.xml](/devices/c1p/machine/8kb/large/machine.xml) configuration.
After it loads, use your browser's "View Source" command and you'll see that it's very similar to the
@ -107,10 +107,10 @@ Step 3: Add the C1Pjs Simulator to your web page
---
Somewhere on your page, you need to add the following **&lt;script&gt;** element:
<script type="text/javascript" src="http://www.pcjs.org/versions/c1pjs/1.15.3/c1p.js"></script>
<script type="text/javascript" src="http://www.pcjs.org/versions/c1pjs/1.17.1/c1p.js"></script>
To include the C1Pjs Debugger, use [c1p-dbg.js](/versions/c1pjs/1.15.3/c1p-dbg.js) instead of
[c1p.js](/versions/c1pjs/1.15.3/c1p.js), and include some additional definitions in your machine
To include the C1Pjs Debugger, use [c1p-dbg.js](/versions/c1pjs/1.17.1/c1p-dbg.js) instead of
[c1p.js](/versions/c1pjs/1.17.1/c1p.js), and include some additional definitions in your machine
definition XML file:
<machine id="OSI" border="1" width="272px">
@ -143,13 +143,15 @@ The **embedC1P()** function accepts three parameters:
- the *id* attribute of the HTML element that will contain the simulator (eg, 'myC1P');
- the URL of your machine definition XML file (eg, 'embed.xml', since it's on the same server);
- the URL of an XML stylesheet; unless you've created your own stylesheet, it's recommended you omit this
parameter and use the default [XML stylesheet](/versions/c1pjs/1.15.3/components.xsl).
parameter and use the default [XML stylesheet](/versions/c1pjs/1.17.1/components.xsl).
Step 5: Enjoy!
---
All I ask is that any page that embeds the simulator also includes the following attribution: a link to this
website ([pcjs.org](http://www.pcjs.org/)) and my contact info ([@jeffpar](http://twitter.com/jeffpar)).
If you use the default [XML stylesheet](/versions/c1pjs/1.15.3/components.xsl), attribution is automatically inserted,
All I ask is that any page that embeds the simulator also includes attribution, such as:
> [PCjs](http://pcjs.org) © 2012-2015 by [Jeff Parsons](mailto:Jeff@pcjs.org) ([@jeffpar](http://twitter.com/jeffpar))
If you use the default [XML stylesheet](/versions/c1pjs/1.17.1/components.xsl), attribution is automatically inserted,
which relieves you from including it yourself.
Feel free to copy any or all of the files listed above to your own server (it's probably better to share the server