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

README updates

Browse source
This commit is contained in:
Jeff Parsons 2016-06-06 09:17:25 -07:00
commit 1d81e555b2
4 changed files with 13 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

9
api/v1/dump/README.md
View file

@ -18,14 +18,13 @@ PCjs DiskDump and FileDump API
===
The PCjs [DiskDump](/modules/diskdump/) and [FileDump](/modules/filedump/) API are not fully supported
by the current PCjs web server.
When **pcjs.org** switched from a Node-based web server running on
[Amazon Web Services](https://aws.amazon.com/elasticbeanstalk/) to
[GitHub Pages](https://pages.github.com/), the original server-side API had to be abandoned.
by the current PCjs web server. When [pcjs.org](http://www.pcjs.org/) switched from a Node-based web server running on
[Amazon Web Services](https://aws.amazon.com/elasticbeanstalk/) to [GitHub Pages](https://pages.github.com/),
the original server-side API had to be abandoned.
However, we're working on a client-side replacement of the API that will run
entirely in your browser, so hopefully portions of the original API will be available in the near future.
In the meantime, check out the
[Developer Notes](https://github.com/jeffpar/pcjs#user-content-developer-notes) section of the
[PCjs Project](https://github.com/jeffpar/pcjs) for instructions on running your own local copy of Node.js and the
[PCjs Project](https://github.com/jeffpar/pcjs) for instructions on running your own local copy of Node and the
PCjs web server.

2
devices/README.md
View file

@ -15,7 +15,7 @@ All PCjs machines are built from the following sets of devices:
* [6502-based Devices](c1p/) (e.g., [Challenger 1P](c1p/machine/))
* [8080-based Devices](pc8080/) (e.g., [Space Invaders](pc8080/machine/invaders/))
* [8086-based Devices](pcx86/) (e.g., [IBM PC, including 80286 and 80386-based compatibles](pcx86/machine/))
* [8086-based Devices](pcx86/) (e.g., [IBM PC and compatibles](pcx86/machine/))
These devices are user-installable components that you would typically find in a real personal computer,
such as keyboards, disk drive controllers with one or more drives, video cards, etc.

5
devices/pcx86/machine/README.md
View file

@ -16,16 +16,13 @@ PCjs supports these early [IBM PC Machines](#ibm-pc-machines):
* [IBM PC XT](/devices/pcx86/machine/5160/) (Model 5160)
* [IBM PC AT](/devices/pcx86/machine/5170/) (Model 5170)
PCjs also supports IBM PC-compatibles, such as:
PCjs also supports IBM PC-compatibles such as:
* [AT&T](/devices/pcx86/machine/att/) ([AT&T 6300](/devices/pcx86/machine/att/6300/))
* [Columbia Data Products](/devices/pcx86/machine/cdp/) ([MPC 1600](/devices/pcx86/machine/cdp/mpc1600/cga/640kb/))
* [COMPAQ](/devices/pcx86/machine/compaq/) ([DeskPro 386](/devices/pcx86/machine/compaq/deskpro386/))
* [Zenith Data Systems](/devices/pcx86/machine/zenith/) ([Z-150](/devices/pcx86/machine/zenith/z150/cga/640kb/))
Learn more about the [Devices](/devices/) used to build all our machines, such as the 6502-based
[Ohio Scientific Challenger 1P](/devices/c1p/machine/).
### Ready-To-Run App Demos
Machines from our [IBM PC Application Archive](/apps/pcx86/):

14
disks/README.md
View file

@ -18,15 +18,15 @@ Browse these PCjs Disk Libraries:
### PCx86 Disk Image Formats
PCx86 works best with disk images in a **JSON** format, to save conversion time, so that's the only disk image format
you'll find in the PCjs Project.
you'll find in the [PCjs Project](https://github.com/jeffpar/pcjs).
To convert any of our **JSON** disk images back into an **IMG** file, you can use the [DiskDump API](/api/v1/dump)
with the *format* parameter set to `img` instead of `json`. For example:
If you're running the PCjs Node web server, you can convert any of our **JSON** disk images into an **IMG** file
with the [DiskDump API](/api/v1/dump), by setting the *format* parameter set to `img` instead of `json`. For example:
{{ site.url }}/api/v1/dump?disk=/disks/pcx86/dos/ibm/2.00/PCDOS200-DISK1.json&format=img
As an added bonus, when browsing the disk library with the PCjs Node web server, links to JSON-encoded disk images
automatically include "onclick" handlers that invoke the API for you.
As an added bonus, the PCjs Node web server automatically provides "onclick" handlers for all links to JSON-encoded disk
images, automatically invoking the API for you.
See **Creating PCx86-Compatible Disk Images** in the [PCx86 Documentation](/docs/pcx86/#creating-pcx86-compatible-disk-images)
for more information about supported disks and formats.
See [Creating PCx86-Compatible Disk Images](/docs/pcx86/#creating-pcx86-compatible-disk-images) in the
[PCx86 Documentation](/docs/pcx86/) for more information about supported disks and formats.