More README tweaks
This commit is contained in:
parent
383de1cd8a
commit
6bb1139a3f
6 changed files with 12 additions and 12 deletions
|
|
@ -146,10 +146,10 @@ contains a machine XML file, that is embedded as well.
|
||||||
The PCjs client app can also be run from the command-line mode using Node, making it possible to script the application,
|
The PCjs client app can also be run from the command-line mode using Node, making it possible to script the application,
|
||||||
run a series of automated tests, etc:
|
run a series of automated tests, etc:
|
||||||
|
|
||||||
cd ./my_modules/pcjs-client/bin
|
cd my_modules/pcjs-client/bin
|
||||||
node pcjs
|
node pcjs
|
||||||
|
|
||||||
The [pcjs](my_modules/pcjs-client/bin/pcjs) script in [/my_modules/pcjs-client/bin](my_modules/pcjs-client/bin) loads
|
The [pcjs](my_modules/pcjs-client/bin/pcjs) script in [my_modules/pcjs-client/bin](my_modules/pcjs-client/bin) loads
|
||||||
all the PCjs browser scripts listed in [package.json](/package.json), and then it starts a Node REPL ("read-eval-print loop").
|
all the PCjs browser scripts listed in [package.json](/package.json), and then it starts a Node REPL ("read-eval-print loop").
|
||||||
The REPL handles a few special commands (eg, "load", "quit") and passes anything else to the PCjs Debugger component.
|
The REPL handles a few special commands (eg, "load", "quit") and passes anything else to the PCjs Debugger component.
|
||||||
If no Debugger component has been created yet, or if the Debugger didn't recognize the command, then it's passed on to *eval()*,
|
If no Debugger component has been created yet, or if the Debugger didn't recognize the command, then it's passed on to *eval()*,
|
||||||
|
|
@ -240,12 +240,12 @@ updates, changes to README.md files, etc. So, before running Node, you may want
|
||||||
|
|
||||||
touch my_modules/shared/templates/common.html
|
touch my_modules/shared/templates/common.html
|
||||||
|
|
||||||
The [HTMLOut](/my_modules/htmlout/) module compares the timestamp of that template file to the timestamp of any
|
The [HTMLOut](my_modules/htmlout/) module compares the timestamp of that template file to the timestamp of any
|
||||||
"index.html" and will regenerate the latter if it's out-of-date.
|
"index.html" and will regenerate the latter if it's out-of-date.
|
||||||
|
|
||||||
There's a TODO to expand that check to include the timestamp of any local README.md file, but there are many other
|
There's a TODO to expand that check to include the timestamp of any local README.md file, but there are many other
|
||||||
factors that can contribute to stale "index.html" files, so usually the safest thing to do is "touch" the
|
factors that can contribute to stale "index.html" files, so usually the safest thing to do is "touch" the
|
||||||
[common.html](/my_modules/shared/templates/common.html) template, or delete all existing "index.html" files, either
|
[common.html](my_modules/shared/templates/common.html) template, or delete all existing "index.html" files, either
|
||||||
manually or with the Grunt "clean" task:
|
manually or with the Grunt "clean" task:
|
||||||
|
|
||||||
grunt clean
|
grunt clean
|
||||||
|
|
|
||||||
|
|
@ -68,11 +68,11 @@ of the project that have been published here are free for redistribution and/or
|
||||||
of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License,
|
of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License,
|
||||||
or (at your option) any later version.
|
or (at your option) any later version.
|
||||||
|
|
||||||
You are required to include the appropriate copyright notice (e.g., `PCjs v1.13.5 © 2012-2014 by @jeffpar`)
|
You are required to include the appropriate copyright notice (e.g., `PCjs v1.15.3 © 2012-2014 by @jeffpar`)
|
||||||
in every source code file of every copy or modified version of this work, and to display that copyright notice
|
in every source code file of every copy or modified version of this work, and to display that copyright notice
|
||||||
on every screen that loads or runs any version of this software.
|
on every screen that loads or runs any version of this software.
|
||||||
|
|
||||||
See [COPYING](/COPYING) for details.
|
See [LICENSE](/LICENSE) for details.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -12,7 +12,7 @@ To use them, download [samples.zip](samples.zip), unzip it into a folder on your
|
||||||
- [sample3b.html](sample3b.html) and [sample3b.xml](sample3b.xml)
|
- [sample3b.html](sample3b.html) and [sample3b.xml](sample3b.xml)
|
||||||
+ Feel free to copy/paste additional components from other machine XML files on [pcjs.org](http://www.pcjs.org/).
|
+ Feel free to copy/paste additional components from other machine XML files on [pcjs.org](http://www.pcjs.org/).
|
||||||
+ Please display the current version and appropriate attribution; e.g.:
|
+ Please display the current version and appropriate attribution; e.g.:
|
||||||
[PCjs Simulator](http://www.pcjs.org/) v1.13.5 © 2012-2014 by [@jeffpar](http://twitter.com/jeffpar)
|
[PCjs Simulator](http://www.pcjs.org/) v1.15.3 © 2012-2014 by [@jeffpar](http://twitter.com/jeffpar)
|
||||||
+ Remember to check the [pcjs.org](http://www.pcjs.org/) website periodically, to keep your copy of PCjs up-to-date.
|
+ Remember to check the [pcjs.org](http://www.pcjs.org/) website periodically, to keep your copy of PCjs up-to-date.
|
||||||
|
|
||||||
<!--BEGIN:EXCLUDE-->
|
<!--BEGIN:EXCLUDE-->
|
||||||
|
|
|
||||||
Binary file not shown.
|
|
@ -163,7 +163,7 @@ var aMachineFileTypes = {
|
||||||
};
|
};
|
||||||
|
|
||||||
var asNonDirectories = [
|
var asNonDirectories = [
|
||||||
"COPYING"
|
"LICENSE"
|
||||||
];
|
];
|
||||||
|
|
||||||
/*
|
/*
|
||||||
|
|
@ -182,7 +182,7 @@ var asNonDirectories = [
|
||||||
* should now be removed from the project).
|
* should now be removed from the project).
|
||||||
*/
|
*/
|
||||||
var asFilesNonListed = [
|
var asFilesNonListed = [
|
||||||
"COPYING",
|
"LICENSE",
|
||||||
"index.html",
|
"index.html",
|
||||||
"robots.txt",
|
"robots.txt",
|
||||||
"machine.xml",
|
"machine.xml",
|
||||||
|
|
|
||||||
|
|
@ -13,7 +13,7 @@
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "git://github.com/jeffpar/jsmachines.git"
|
"url": "git://github.com/jeffpar/pcjs.git"
|
||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"pcjs",
|
"pcjs",
|
||||||
|
|
@ -30,9 +30,9 @@
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"bugs": {
|
"bugs": {
|
||||||
"url": "https://github.com/jeffpar/jsmachines/issues"
|
"url": "https://github.com/jeffpar/pcjs/issues"
|
||||||
},
|
},
|
||||||
"homepage": "https://github.com/jeffpar/jsmachines",
|
"homepage": "https://github.com/jeffpar/pcjs",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"express": "~3.4.8",
|
"express": "~3.4.8",
|
||||||
"express-slash": "^1.0.0",
|
"express-slash": "^1.0.0",
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue