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

More README updates

Browse source
This commit is contained in:
Jeff Parsons 2015-12-13 16:39:41 -08:00
commit ce068f2655
8 changed files with 41 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/pcjs/README.md
View file

@ -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