More README updates
This commit is contained in:
Jeff Parsons
parent
de520d914f
commit
ce068f2655
8 changed files with 41 additions and 18 deletions
|
|
@ -70,7 +70,7 @@ Developer Notes
|
|||
|
||||
The [PCjs repository](https://github.com/jeffpar/pcjs) on GitHub contains everything needed to run PCjs
|
||||
computer simulations. The [PCjs](/docs/pcjs/) and [C1Pjs](/docs/c1pjs/) emulators run in any modern web browser,
|
||||
with or without a web server, and examples are provided for both [local](/docs/pcjs/demos/) and [remote](http://www.pcjs.org/)
|
||||
with or without a web server, and examples are provided for both [local](/docs/pcjs/demos/) and [remote]({{ site.url }}/)
|
||||
operation.
|
||||
|
||||
The project includes:
|
||||
|
|
@ -224,7 +224,7 @@ like a good little REPL.
|
|||
|
||||
Use the "load" command to load a JSON machine configuration file. A sample [ibm5150.json](modules/pcjs/bin/ibm5150.json)
|
||||
is provided in the *bin* directory, which is a "JSON-ified" version of the [machine.xml](devices/pc/machine/5150/mda/64kb/machine.xml)
|
||||
displayed on the [pcjs.org](/) home page.
|
||||
displayed on the [{{ site.pcjs_domain }}]({{ site.url }}/) home page.
|
||||
|
||||
The command-line loader creates all the JSON-defined machine components in the same order that the browser creates
|
||||
XML-defined components. You can also issue the "load" command directly from the command-line:
|
||||
|
|
@ -355,9 +355,9 @@ All published portions are free for redistribution and/or modification under the
|
|||
[GNU General Public License](/LICENSE) as published by the Free Software Foundation, either version 3 of the License,
|
||||
or (at your option) any later version.
|
||||
|
||||
You are required to include the following copyright notice, with a link to [{{ site.pcjs_domain }}]({{ site.url }}):
|
||||
You are required to include the following copyright notice, with a link to [{{ site.pcjs_domain }}]({{ site.url }}/):
|
||||
|
||||
> [PCjs]({{ site.url }}) © 2012-2015 by [Jeff Parsons](mailto:Jeff@pcjs.org) ([@jeffpar](http://twitter.com/jeffpar))
|
||||
> [PCjs]({{ site.url }}/) © 2012-2015 by [Jeff Parsons](mailto:Jeff@pcjs.org) ([@jeffpar](http://twitter.com/jeffpar))
|
||||
|
||||
in every source code file of every copy or modified version of this work, and to display that notice on every web page
|
||||
or computer that runs any version of this software.
|
||||
|
|
|
|||
|
|
@ -31,9 +31,9 @@ should contain the following information about the software:
|
|||
- Machine (reference to PCjs machine.xml file capable of loading/running the software)
|
||||
- Disk(s) (one or more entries describing sets of files and/or disk images)
|
||||
|
||||
The distinctions made by Type and Category are a bit aribitrary and likely to change. For now,
|
||||
Type is merely a reflection of how we initially filed the software (eg, under [/diags](/disks/pc/diags/),
|
||||
[/games](/disks/pc/games/), [/tools](/disks/pc/tools/), etc), while Category provides more detail.
|
||||
The distinctions made by Type and Category are a bit arbitrary and likely to change. For now,
|
||||
Type is merely a reflection of how we initially filed the original [disks](/disks/pc/), while Category
|
||||
provides more detail.
|
||||
|
||||
### Example: VisiCalc
|
||||
|
||||
|
|
@ -72,7 +72,7 @@ which refers to the <disk> entry in the VisiCalc manifest -- which brings
|
|||
Since that <disk> entry is just a reference to a folder, PCjs must first convert it to a disk image,
|
||||
using the following API request:
|
||||
|
||||
http://www.pcjs.org/api/v1/dump?path=/apps/pc/1981/visicalc/bin/VC.COM;../README.md&format=json
|
||||
http://localhost:8088/api/v1/dump?path=/apps/pc/1981/visicalc/bin/VC.COM;../README.md&format=json
|
||||
|
||||
The PCjs DiskDump module processes the dump request and generates a JSON-encoded DOS 2.x-compatible disk image
|
||||
containing all the specified files.
|
||||
|
|
|
|||
|
|
@ -88,7 +88,7 @@ The `-o0x8000` argument is required to "org" the file at the proper starting add
|
|||
are optional; they simply establish a few sync points within the ROM image that save a little cleanup effort, by
|
||||
preventing disassembly in the middle of instructions.
|
||||
|
||||
Next, the PCjs [TextOut](/modules/textout/lib/) command, with the *--nasm* option, prepares the code for reassembly:
|
||||
Next, the PCjs [TextOut](/modules/textout/) command, with the *--nasm* option, prepares the code for reassembly:
|
||||
|
||||
node ../../../../../../modules/textout/bin/textout --file=1988-01-28.nasm --nasm > temp.nasm
|
||||
mv temp.nasm 1988-01-28.nasm
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ permalink: /docs/about/
|
|||
|
||||
The JavaScript Machines Project (originally at [jsmachines.net](http://jsmachines.net/)) is a collection of computer
|
||||
simulations written in JavaScript. It has now been released on [GitHub](https://github.com/) as the
|
||||
[PCjs Project](https://github.com/jeffpar/pcjs), a copy of which is hosted here at [{{ site.pcjs_domain }}]({{ site.url }}).
|
||||
[PCjs Project](https://github.com/jeffpar/pcjs), a copy of which is hosted here at [{{ site.pcjs_domain }}]({{ site.url }}/).
|
||||
|
||||
The goals of the project are to create fast, full-featured simulations of classic computer
|
||||
hardware, help people understand how these early machines worked, make it easy to experiment with different machine
|
||||
|
|
@ -28,7 +28,7 @@ The first JavaScript Machines simulation was [C1Pjs](/docs/c1pjs/), a simulation
|
|||
Challenger 1P, which was a 6502-based microcomputer introduced by Ohio Scientific in 1978.
|
||||
|
||||
C1Pjs v1.0 was released in July 2012, first on ecpsim.org and cpusim.org, then on [jsmachines.net](http://jsmachines.net/c1pjs),
|
||||
and finally [{{ site.pcjs_domain }}]({{ site.url }}). More information about the first release of C1Pjs was also
|
||||
and finally [{{ site.pcjs_domain }}]({{ site.url }}/). More information about the first release of C1Pjs was also
|
||||
[posted](http://osiweb.org/osiforum/viewtopic.php?f=3&t=103) on the [OSI Discussion Forum](http://osiweb.org/osiforum/index.php)
|
||||
at [osiweb.org](http://osiweb.org/).
|
||||
|
||||
|
|
@ -75,9 +75,9 @@ All published portions are free for redistribution and/or modification under the
|
|||
[GNU General Public License](/LICENSE) as published by the Free Software Foundation, either version 3 of the License,
|
||||
or (at your option) any later version.
|
||||
|
||||
You are required to include the following copyright notice, with a link to [{{ site.pcjs_domain }}]({{ site.url }}):
|
||||
You are required to include the following copyright notice, with a link to [{{ site.pcjs_domain }}]({{ site.url }}/):
|
||||
|
||||
> [PCjs]({{ site.url }}) © 2012-2015 by [Jeff Parsons](mailto:Jeff@pcjs.org) ([@jeffpar](http://twitter.com/jeffpar))
|
||||
> [PCjs]({{ site.url }}/) © 2012-2015 by [Jeff Parsons](mailto:Jeff@pcjs.org) ([@jeffpar](http://twitter.com/jeffpar))
|
||||
|
||||
in every source code file of every copy or modified version of this work, and to display that notice on every web page
|
||||
or computer that runs any version of this software.
|
||||
|
|
|
|||
|
|
@ -142,10 +142,10 @@ All of the demos described above are available for [download](/docs/pcjs/demos/)
|
|||
|
||||
### Creating PCjs-Compatible Disk Images
|
||||
|
||||
If you have (or find) an IMG disk image file on a server, [pcjs.org](http://www.pcjs.org/) provides a
|
||||
**DiskDump API** via endpoint "/api/v1/dump" that creates PCjs-compatible disks in JSON:
|
||||
If you have (or find) an IMG disk image file on a server, the PCjs web server provides a **DiskDump API** via endpoint
|
||||
"/api/v1/dump" that creates PCjs-compatible disks in JSON:
|
||||
|
||||
http://www.pcjs.org/api/v1/dump?disk=(file|url)&format=json
|
||||
http://localhost:8088/api/v1/dump?disk=(file|url)&format=json
|
||||
|
||||
For example, let's say you found a disk image online:
|
||||
|
||||
|
|
@ -153,12 +153,12 @@ For example, let's say you found a disk image online:
|
|||
|
||||
To convert it to a PCjs-compatible JSON format, use the following command:
|
||||
|
||||
http://www.pcjs.org/api/v1/dump?disk=http://static.pcjs.org/disks/pc/dos/ibm/1.00/PCDOS100.img&format=json
|
||||
http://localhost:8088/api/v1/dump?disk=http://static.pcjs.org/disks/pc/dos/ibm/1.00/PCDOS100.img&format=json
|
||||
|
||||
Save the resulting JSON file to a folder on your server, and then update your machine XML file(s) to use that file.
|
||||
If necessary, you can also reverse the process, converting a JSON disk image back into an IMG file:
|
||||
|
||||
http://www.pcjs.org/api/v1/dump?disk=http://www.pcjs.org/disks/pc/dos/ibm/1.00/PCDOS100.json&format=img
|
||||
http://localhost:8088/api/v1/dump?disk=http://www.pcjs.org/disks/pc/dos/ibm/1.00/PCDOS100.json&format=img
|
||||
|
||||
Although PCjs will accept IMG disk image files, it must call the [DiskDump API](/api/v1/dump)
|
||||
to convert the image every time it's loaded, so it's *much* faster and more efficient to use pre-converted
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
layout: page
|
||||
title: DiskDump
|
||||
permalink: /modules/diskdump/
|
||||
---
|
||||
|
||||
DiskDump
|
||||
===
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
layout: page
|
||||
title: FileDump
|
||||
permalink: /modules/filedump/
|
||||
---
|
||||
|
||||
FileDump
|
||||
===
|
||||
|
||||
Module (and command-line utility) for converting the contents of files to JSON.
|
||||
|
|
|
|||
10
modules/textout/README.md
Normal file
10
modules/textout/README.md
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
---
|
||||
layout: page
|
||||
title: TextOut
|
||||
permalink: /modules/textout/
|
||||
---
|
||||
|
||||
TextOut
|
||||
===
|
||||
|
||||
**TextOut** is a Node module with a command-line interface for massaging NASM disassembly listings.
|
||||
Loading…
Reference in a new issue