Fixed some README links
This commit is contained in:
parent
c08d399d3f
commit
148c5a2749
2 changed files with 21 additions and 17 deletions
34
README.md
34
README.md
|
|
@ -77,7 +77,7 @@ The project includes:
|
||||||
- Custom Node modules used by the web server ([HTMLOut](modules/htmlout/), [MarkOut](modules/markout/), [DiskDump](modules/diskdump/), [FileDump](modules/filedump/))
|
- Custom Node modules used by the web server ([HTMLOut](modules/htmlout/), [MarkOut](modules/markout/), [DiskDump](modules/diskdump/), [FileDump](modules/filedump/))
|
||||||
- A variety of IBM PC and C1P configuration and resource files (see [/apps](apps/), [/devices](devices/) and [/disks](disks/))
|
- A variety of IBM PC and C1P configuration and resource files (see [/apps](apps/), [/devices](devices/) and [/disks](disks/))
|
||||||
- The [PCx86](modules/pcx86/), [PC8080](modules/pc8080/), and [C1Pjs](modules/c1pjs/) client applications, both "compiled" and uncompiled
|
- The [PCx86](modules/pcx86/), [PC8080](modules/pc8080/), and [C1Pjs](modules/c1pjs/) client applications, both "compiled" and uncompiled
|
||||||
- A smattering of [PCx86](docs/pcx86/) and [C1Pjs](docs/c1pjs/) documentation, along with [blog posts](blog/), related [publications](pubs/) and more
|
- A smattering of [PCx86](docs/pcx86/) and [C1Pjs](docs/c1pjs/) documentation, along with [blog posts](https://github.com/jeffpar/pcjs/tree/gh-pages/_posts), related [publications](pubs/) and more
|
||||||
|
|
||||||
The bundled web server is not strictly required. Any web server (Node, Apache, Nginx, etc) that can serve the necessary
|
The bundled web server is not strictly required. Any web server (Node, Apache, Nginx, etc) that can serve the necessary
|
||||||
JavaScript files to your browser will work. However, instructions for doing that are beyond the scope of this introduction.
|
JavaScript files to your browser will work. However, instructions for doing that are beyond the scope of this introduction.
|
||||||
|
|
@ -130,9 +130,9 @@ quintessential "stuck in the past" project), but there's also no urgency to upda
|
||||||
|
|
||||||
### Installing PCjs with Jekyll
|
### Installing PCjs with Jekyll
|
||||||
|
|
||||||
PCjs can also be used with [Jekyll](http://jekyllrb.com) and the WEBrick web server, now that the project
|
PCjs can also be used with [Jekyll](http://jekyllrb.com) and the Ruby WEBrick web server, now that a
|
||||||
has been converted to work with [GitHub Pages](https://pages.github.com). This is how the project is currently
|
*[gh-pages](https://github.com/jeffpar/pcjs/tree/gh-pages)* branch has been created to work with
|
||||||
set up at [pcjs.org](http://www.pcjs.org/).
|
[GitHub Pages](https://pages.github.com). This is how the project is currently set up at [pcjs.org](http://www.pcjs.org/).
|
||||||
|
|
||||||
This isn't going to be a Jekyll "How To" guide, because that would unnecessarily repeat all the information available
|
This isn't going to be a Jekyll "How To" guide, because that would unnecessarily repeat all the information available
|
||||||
at [GitHub Pages](https://pages.github.com). But we'll summarize the basic steps, which replace the `npm` and `node`
|
at [GitHub Pages](https://pages.github.com). But we'll summarize the basic steps, which replace the `npm` and `node`
|
||||||
|
|
@ -145,24 +145,28 @@ To install Jekyll for use with PCjs:
|
||||||
3. Create a `Gemfile` containing `gem 'github-pages'` (this is already checked in)
|
3. Create a `Gemfile` containing `gem 'github-pages'` (this is already checked in)
|
||||||
4. Run `bundle install` (GitHub Pages alternatively suggests: `bundle exec jekyll build --safe`)
|
4. Run `bundle install` (GitHub Pages alternatively suggests: `bundle exec jekyll build --safe`)
|
||||||
5. Checkout the `gh-pages` branch, since only that branch contains all the Jekyll-related files
|
5. Checkout the `gh-pages` branch, since only that branch contains all the Jekyll-related files
|
||||||
6. Run `bundle exec jekyll serve --host=0.0.0.0 --config _config.yml` to start the web server
|
6. Run `bundle exec jekyll serve` to start the web server
|
||||||
|
|
||||||
Now open a web browser and go to `http://localhost:4000/`. You're done!
|
Now open a web browser and go to `http://localhost:4000/`. You're done!
|
||||||
|
|
||||||
Using the `--host` option makes it possible to access the web server from other devices on your local network;
|
Some useful Jekyll server options include:
|
||||||
for example, you may want to run PCjs on your iPhone, iPad, or other wireless device.
|
|
||||||
|
|
||||||
Another useful variation is `--config _config.yml,_developer.yml` which uses the settings in `_developer.yml`
|
bundle exec jekyll serve --host=0.0.0.0 --config _config.yml,_developer.yml
|
||||||
to override the defaults in `_config.yml`. Using development (non-production) settings in `_developer.yml` is
|
|
||||||
analogous to running the Node web server with certain development options; see [Debugging PCjs](#debugging-pcjs).
|
|
||||||
|
|
||||||
Don't see any YML files in the root of your project? You probably forgot to switch to the `gh-pages` branch:
|
The `--host` option makes it possible to access the web server from other devices on your local network;
|
||||||
|
for example, you may want to run PCjs on your iPhone, iPad, or other wireless device. And by adding `_developer.yml`,
|
||||||
|
you can override the Jekyll configuration defaults in `_config.yml`. Using development (non-production) settings in
|
||||||
|
`_developer.yml` is analogous to running the Node web server with certain development options; see
|
||||||
|
[Debugging PCjs](#debugging-pcjs).
|
||||||
|
|
||||||
|
Don't see any YML files in the root of your project? You probably forgot to switch to the
|
||||||
|
*[gh-pages](https://github.com/jeffpar/pcjs/tree/gh-pages)* branch:
|
||||||
|
|
||||||
git checkout gh-pages
|
git checkout gh-pages
|
||||||
|
|
||||||
GitHub Pages says you can run `jekyll serve` instead of `bundle exec jekyll serve`, but with the addition of
|
GitHub Pages says you can run `jekyll serve` instead of `bundle exec jekyll serve`, but with the addition of
|
||||||
more gems to `Gemfile` (eg, `jekyll-sitemap`), running `jekyll serve` may trigger dependency errors on some systems.
|
more gems to `Gemfile` (eg, `jekyll-sitemap`), running `jekyll serve` may trigger dependency errors on some systems.
|
||||||
`bundle exec ...` should always work.
|
`bundle exec jekyll serve` should always work.
|
||||||
|
|
||||||
Last but not least, run `bundle update` periodically to keep Jekyll up-to-date.
|
Last but not least, run `bundle update` periodically to keep Jekyll up-to-date.
|
||||||
|
|
||||||
|
|
@ -231,7 +235,7 @@ if the folder contains a machine XML file, that is embedded as well.
|
||||||
|
|
||||||
To work well with both the Node and Jekyll web servers, all Markdown files containing one or more embedded machines
|
To work well with both the Node and Jekyll web servers, all Markdown files containing one or more embedded machines
|
||||||
should contain a Jekyll "Front Matter" header that describes the machines. For example, here's the header from the
|
should contain a Jekyll "Front Matter" header that describes the machines. For example, here's the header from the
|
||||||
pcjs.org home page ([index.md](index.md)):
|
pcjs.org home page ([index.md](https://github.com/jeffpar/pcjs/blob/gh-pages/index.md)):
|
||||||
|
|
||||||
---
|
---
|
||||||
layout: page
|
layout: page
|
||||||
|
|
@ -253,7 +257,7 @@ Then the following lines are inserted at the points where the machines should ap
|
||||||
{% include machine.html id="demoC1P" %}
|
{% include machine.html id="demoC1P" %}
|
||||||
|
|
||||||
For more information on all the machine options supported in a Markdown file, see the project's Jekyll include file
|
For more information on all the machine options supported in a Markdown file, see the project's Jekyll include file
|
||||||
[machine-engines.html](/_includes/machine-engines.html).
|
[machine-engines.html](https://github.com/jeffpar/pcjs/blob/gh-pages/_includes/machine-engines.html).
|
||||||
|
|
||||||
### From The Command-Line
|
### From The Command-Line
|
||||||
|
|
||||||
|
|
@ -373,7 +377,7 @@ Updating PCjs
|
||||||
|
|
||||||
To start developing features for a new version of PCjs, here are the recommended steps:
|
To start developing features for a new version of PCjs, here are the recommended steps:
|
||||||
|
|
||||||
1. Change the version number in the root [package.json](package.json) and [_config.yml](_config.yml)
|
1. Change the version number in the root [package.json](package.json) (and [_config.yml](https://github.com/jeffpar/pcjs/blob/gh-pages/_config.yml))
|
||||||
2. Run the "grunt promote" task to bump the version in all the machine XML files
|
2. Run the "grunt promote" task to bump the version in all the machine XML files
|
||||||
3. Make changes
|
3. Make changes
|
||||||
4. Run "grunt" to build new versions of the apps (eg, "/versions/pcx86/1.x.x/pcx86.js")
|
4. Run "grunt" to build new versions of the apps (eg, "/versions/pcx86/1.x.x/pcx86.js")
|
||||||
|
|
|
||||||
|
|
@ -48,7 +48,7 @@ The ROM contains 128 rows of character data, 16 bytes per character. More on th
|
||||||
### Disassembling the 8080 Firmware
|
### Disassembling the 8080 Firmware
|
||||||
|
|
||||||
Following in the footsteps of [vt100romhax](http://vt100romhax.tumblr.com/post/90697428973/the-vt100-memory-map-and-8080-disassembly),
|
Following in the footsteps of [vt100romhax](http://vt100romhax.tumblr.com/post/90697428973/the-vt100-memory-map-and-8080-disassembly),
|
||||||
I disassembled the ROM, using `dz80` from [D52](http://www.brouhaha.com/~eric/software/d52/) ([manual](http://www.bipom.com/documents/dis51/d52manual.html)):
|
I disassembled the ROM, using `dz80` from [D52](http://www.brouhaha.com/~eric/software/d52/) (here's the [manual](http://www.bipom.com/documents/dis51/d52manual.html)):
|
||||||
|
|
||||||
dz80 -80 VT100.bin
|
dz80 -80 VT100.bin
|
||||||
|
|
||||||
|
|
@ -61,7 +61,7 @@ Finally, I verified that reassembling [VT100.asm](VT100.asm) with [asm8080](http
|
||||||
original VT100.bin; after adding the correct number of `nop` instructions to the end to the source file, the binaries matched.
|
original VT100.bin; after adding the correct number of `nop` instructions to the end to the source file, the binaries matched.
|
||||||
|
|
||||||
The other advantage of reassembling the code is that the resulting [VT100.lst](VT100.lst) makes it easy to export comments
|
The other advantage of reassembling the code is that the resulting [VT100.lst](VT100.lst) makes it easy to export comments
|
||||||
and other symoblic information to [VT100.map](VT100.map), which can then be included in the [VT100.json](VT100.json) ROM dump
|
and other symbolic information to [VT100.map](VT100.map), which can then be included in the [VT100.json](VT100.json) ROM dump
|
||||||
and passed on to the PC8080 Debugger. Here are the rebuild steps:
|
and passed on to the PC8080 Debugger. Here are the rebuild steps:
|
||||||
|
|
||||||
asm8080 -lVT100.lst VT100.asm
|
asm8080 -lVT100.lst VT100.asm
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue