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

Fixed some README links

Browse source
This commit is contained in:
Jeff Parsons 2016-08-21 08:57:54 -07:00
commit 148c5a2749
2 changed files with 21 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

34
README.md
View file

@ -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/))
- 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
- 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
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
PCjs can also be used with [Jekyll](http://jekyllrb.com) and the WEBrick web server, now that the project
has been converted to work with [GitHub Pages](https://pages.github.com). This is how the project is currently
set up at [pcjs.org](http://www.pcjs.org/).
PCjs can also be used with [Jekyll](http://jekyllrb.com) and the Ruby WEBrick web server, now that a
*[gh-pages](https://github.com/jeffpar/pcjs/tree/gh-pages)* branch has been created to work with
[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
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)
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
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!
Using 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.
Some useful Jekyll server options include:
Another useful variation is `--config _config.yml,_developer.yml` which uses the settings in `_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).
bundle exec jekyll serve --host=0.0.0.0 --config _config.yml,_developer.yml
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` branch:
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
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.
`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.
@ -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
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
@ -253,7 +257,7 @@ Then the following lines are inserted at the points where the machines should ap
{% 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
[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
@ -373,7 +377,7 @@ Updating PCjs
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
3. Make changes
4. Run "grunt" to build new versions of the apps (eg, "/versions/pcx86/1.x.x/pcx86.js")