From 6bb1139a3f1e257d66dc432d9434cb1f96fab8be Mon Sep 17 00:00:00 2001 From: Jeff Parsons Date: Sun, 28 Sep 2014 18:26:31 -0700 Subject: [PATCH] More README tweaks --- README.md | 8 ++++---- docs/about/README.md | 4 ++-- docs/pcjs/demos/README.md | 2 +- docs/pcjs/demos/samples.zip | Bin 452444 -> 452444 bytes my_modules/htmlout/lib/htmlout.js | 4 ++-- package.json | 6 +++--- 6 files changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 9aaa9c50f..0534e2eb0 100644 --- a/README.md +++ b/README.md @@ -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, run a series of automated tests, etc: - cd ./my_modules/pcjs-client/bin + cd my_modules/pcjs-client/bin 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"). 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()*, @@ -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 -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. 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 -[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: grunt clean diff --git a/docs/about/README.md b/docs/about/README.md index 95cd0522d..9acf19c1d 100644 --- a/docs/about/README.md +++ b/docs/about/README.md @@ -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, 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 on every screen that loads or runs any version of this software. -See [COPYING](/COPYING) for details. +See [LICENSE](/LICENSE) for details. --- diff --git a/docs/pcjs/demos/README.md b/docs/pcjs/demos/README.md index 2ebb3ae85..1ea3edd52 100644 --- a/docs/pcjs/demos/README.md +++ b/docs/pcjs/demos/README.md @@ -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) + 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.: - [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. diff --git a/docs/pcjs/demos/samples.zip b/docs/pcjs/demos/samples.zip index b84aaa1dcd7b565916c341656648d23f7e449a5f..19944f6ede9f1597b80b0229ef8171522c4b8eef 100644 GIT binary patch delta 967 zcmca}PWsL{X}$n&W)=|!1_lm>&;o1MiF_*TA63;uyw+-Lw9HXt0f|jssi*`KY`&z} zeo2vW`z1xD^Sqk6lWkm|sxI5r!o4+fM5z~LU zF=@bDv0c-h$+s0EUUh~^6)wK)3{#e{rgeyot3kfyo=Fmn45D1DU}qI1>!u{7>tz*# zoz>{30rFzI(KR=KxoOh5O4O$K86y9aDW%)o?$ zB;@>%%>XXM0ZS^=XFX)o03{2sN^p!nc?i@COb7@Oi$_Qz5DR)Av6;b5g9tr)#AXZ^ zVg^RwbnC}#y3D}1g_r~q>3Ynj2^WEAyY`q(AFd4|r16AJ4^61@35KfEn5tx+VyMb{ yisWr@j2u7~fmkT~3`r40DD4@BQ9F=SiE(lPGbsZDC=R%u13d+dgXw0^+0+0WK1GiJ delta 982 zcmZ9LK}b|V7{}+$o1Ldi3SkT48umn&UC32my0vQ1(%U+Ok?X35Tm=;?Ei($zE)p4r z5K@LyMnOfTWQV%E4nYNWDRX5v_T*t*SEWl(hoV4gzM0je>+k(%zVDmg_ZH`!i}TLh zV@Fi710j@!F5U^6H*!m~bL-zjrqA`le_AI6&p(^v(|WNM-}bnX!z(d;B&I7?Ovlk2 zPu1urbM*H5)G$UUO%TdPg(wsZnDs&LnXaaAHc}tmx(mmw59Ro!qTc&vv7t)*MSXYD zV7&$|(LA-zFnpgda32;}tKNc*YCOB0Kx6FpA?)60&GH<^^;adoG>1z!`I9-^ljj+H zS`(}|>wkSSUqKGLO|;eDS=QBY!rOCRwB_@;pzMf0i7kIpoyjkSGq#2UYHk9d;Rb?i ze3bsq|MHgom+DTCs-(MiRw0MTUUmybt2?7tqcs?aL zZm_&fn1V0p#e8ig|mN#MhIYcfD@C!Z7v{{R?e$3@uRJDze0MU#8`yt+Nn%wD?*zc|NlW)>u0&xU7y()v%c)b!ts}UEx5bi#=GOg);p$Neu#N7Uco4HtgUMtst;B zf@N(i3!7Y`ZUT!TxR9P+qK3+MLEI?FzSI^XYg|uJ-!8;mZ@B@ zybH+aGWBc{X)m!%%L&+%{R(sLH1!fNCz-G|nC3aKCYg}+5pp0)G9jvPh37z&WI|Bi z3ZEYY2`1#c1q5iP@FDqZ9N diff --git a/my_modules/htmlout/lib/htmlout.js b/my_modules/htmlout/lib/htmlout.js index 31eb2d18d..ecce9a315 100644 --- a/my_modules/htmlout/lib/htmlout.js +++ b/my_modules/htmlout/lib/htmlout.js @@ -163,7 +163,7 @@ var aMachineFileTypes = { }; var asNonDirectories = [ - "COPYING" + "LICENSE" ]; /* @@ -182,7 +182,7 @@ var asNonDirectories = [ * should now be removed from the project). */ var asFilesNonListed = [ - "COPYING", + "LICENSE", "index.html", "robots.txt", "machine.xml", diff --git a/package.json b/package.json index 09bb788d2..56bcd1351 100644 --- a/package.json +++ b/package.json @@ -13,7 +13,7 @@ }, "repository": { "type": "git", - "url": "git://github.com/jeffpar/jsmachines.git" + "url": "git://github.com/jeffpar/pcjs.git" }, "keywords": [ "pcjs", @@ -30,9 +30,9 @@ } ], "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": { "express": "~3.4.8", "express-slash": "^1.0.0",