From dcc33e52b3b55d69ce1497a9f7079157d0ccd3a4 Mon Sep 17 00:00:00 2001 From: Jermolene Date: Wed, 15 Oct 2014 21:56:32 +0100 Subject: [PATCH] Docs updates --- bin/readme.md | 8 ++--- .../Releasing a new version of TiddlyWiki.tid | 1 + .../Scripts for TiddlyWiki on Node.js.tid | 30 ++----------------- 3 files changed, 5 insertions(+), 34 deletions(-) diff --git a/bin/readme.md b/bin/readme.md index 5b1443f95..d69837069 100644 --- a/bin/readme.md +++ b/bin/readme.md @@ -1,7 +1,3 @@ -

Script Files

The TiddlyWiki5 repository contains several scripts in the bin folder that are used to build and deploy TiddlyWiki (.sh for *nix and .cmd for Windows). They can serve as a useful starting point for your own scripts.

All the scripts expect to be run from the root folder of the repository.

fullbld: builds tw5.com

This script builds several variants of TiddlyWiki5 for deployment on tiddlywiki.com.

By default, files are output to a folder called jermolene.github.com, sibling to the TiddlyWiki5 repo directory. For example:

/TiddlyWork/ - Directory for working with TiddlyWiki5
-  |
-  +--+-- /TiddlyWiki5/ - Directory containing the TiddlyWiki5 repo from GitHub
-     |
-     +-- /jermolene.github.com/ - Directory for output files

You can override the build output directory by defining the environment variable TW5_BUILD_OUTPUT. The easiest way to do this is to create a personal batch file to invoke TiddlyWiki5 that first sets the environment variable and then invokes fullbld.

fullbld also runs the TiddlyWiki5 Node.js-based test suite (see TestingMechanism)

serve: serves tw5.com

./bin/serve.sh -h
+
Script Files
The TiddlyWiki5 repository contains several scripts in the bin folder that you can use to automate common tasks, or as a useful starting point for your own scripts. See Scripts for building tiddlywiki.com for details of the scripts used to build and release http://tiddlywiki.com/.
All the scripts expect to be run from the root folder of the repository.
serve: serves tw5.com
./bin/serve.sh -h
 ./bin/serve.sh [edition dir] [username] [password] [host] [port]
Or:
./bin/serve.cmd -h
-./bin/serve.cmd [edition dir] [username] [password] [host] [port]
This script starts TiddlyWiki5 running as an HTTP server, defaulting to the content from the tw5.com-server edition. By default, the Node.js serves on port 8080. If the optional username parameter is provided, it is used for signing edits. If the password is provided then HTTP basic authentication is used. Run the script with the -h parameter to see online help.
To experiment with this configuration, run the script and then visit http://127.0.0.1:8080 in a browser.
Changes made in the browser propagate to the server over HTTP (use the browser developer console to see these requests). The server then syncs changes to the file system (and logs each change to the screen).
test: build and run tests
This script runs the test edition of TiddlyWiki on the server to perform the server-side tests and to build test.html for running the tests in the browser.
lazy: serves tw5.com with lazily loaded images
./bin/lazy.sh <username> [<password>]
Or:
./bin/lazy.cmd <username> [<password>]
This script serves the tw5.com-server edition content with LazyLoading applied to images.
wbld: builds TiddlyWiki for TiddlyWeb
This script builds and deploys the code for TiddlyWiki in the Sky for TiddlyWeb. If you want to experiment with your own builds of TiddlyWiki5 for TiddlyWeb you could use this batch file as a base.
2bld: builds TiddlyWiki 2.6.5
This script builds TiddlyWiki 2.6.5 from the original source and then displays the differences between them (diff is used for *nix, fc for Windows).
deploy & verbump: deploy TiddlyWiki and bump the TiddlyWiki version number
These scripts are concerned with releasing a new version of TiddlyWiki. See Releasing a new version of TiddlyWiki5.

\ No newline at end of file
+./bin/serve.cmd [edition dir] [username] [password] [host] [port]

This script starts TiddlyWiki5 running as an HTTP server, defaulting to the content from the tw5.com-server edition. By default, the Node.js serves on port 8080. If the optional username parameter is provided, it is used for signing edits. If the password is provided then HTTP basic authentication is used. Run the script with the -h parameter to see online help.

To experiment with this configuration, run the script and then visit http://127.0.0.1:8080 in a browser.

Changes made in the browser propagate to the server over HTTP (use the browser developer console to see these requests). The server then syncs changes to the file system (and logs each change to the screen).

test: build and run tests

This script runs the test edition of TiddlyWiki on the server to perform the server-side tests and to build test.html for running the tests in the browser.

lazy: serves tw5.com with lazily loaded images

./bin/lazy.sh <username> [<password>]

Or:

./bin/lazy.cmd <username> [<password>]

This script serves the tw5.com-server edition content with LazyLoading applied to images.

2bld: builds TiddlyWiki 2.6.5

This script builds TiddlyWiki 2.6.5 from the original source and then displays the differences between them (diff is used for *nix, fc for Windows).

\ No newline at end of file diff --git a/editions/dev/tiddlers/build/Releasing a new version of TiddlyWiki.tid b/editions/dev/tiddlers/build/Releasing a new version of TiddlyWiki.tid index 246a75ff7..b033f6946 100644 --- a/editions/dev/tiddlers/build/Releasing a new version of TiddlyWiki.tid +++ b/editions/dev/tiddlers/build/Releasing a new version of TiddlyWiki.tid @@ -1,5 +1,6 @@ title: Releasing a new version of TiddlyWiki +# Move the latest release note from the prerelease edition into the tw5.com edition # Adjust the release date of the latest release tiddler (eg, [[Release 5.1.3]]) # Ensure [[Releases]] has the new version as the default tab # Adjust the modified time of HelloThere diff --git a/editions/tw5.com/tiddlers/nodejs/Scripts for TiddlyWiki on Node.js.tid b/editions/tw5.com/tiddlers/nodejs/Scripts for TiddlyWiki on Node.js.tid index e0b33bd25..8c0c250e1 100644 --- a/editions/tw5.com/tiddlers/nodejs/Scripts for TiddlyWiki on Node.js.tid +++ b/editions/tw5.com/tiddlers/nodejs/Scripts for TiddlyWiki on Node.js.tid @@ -1,33 +1,15 @@ created: 20131219100637788 -modified: 20140917190022854 +modified: 20141015165343893 tags: [[TiddlyWiki on Node.js]] title: Scripts for TiddlyWiki on Node.js type: text/vnd.tiddlywiki ! Script Files -The TiddlyWiki5 repository contains several scripts in the `bin` folder that are used to build and deploy TiddlyWiki (`.sh` for *nix and `.cmd` for Windows). They can serve as a useful starting point for your own scripts. +The TiddlyWiki5 repository contains several scripts in the `bin` folder that you can use to automate common tasks, or as a useful starting point for your own scripts. See [[Scripts for building tiddlywiki.com]] for details of the scripts used to build and release http://tiddlywiki.com/. All the scripts expect to be run from the root folder of the repository. -!! `fullbld`: builds tw5.com - -This script builds several variants of TiddlyWiki5 for deployment on tiddlywiki.com. - -By default, files are output to a folder called `jermolene.github.com`, sibling to the TiddlyWiki5 repo directory. For example: - -``` -/TiddlyWork/ - Directory for working with TiddlyWiki5 - | - +--+-- /TiddlyWiki5/ - Directory containing the TiddlyWiki5 repo from GitHub - | - +-- /jermolene.github.com/ - Directory for output files -``` - -You can override the build output directory by defining the environment variable `TW5_BUILD_OUTPUT`. The easiest way to do this is to create a personal batch file to invoke TiddlyWiki5 that first sets the environment variable and then invokes `fullbld`. - -`fullbld` also runs the TiddlyWiki5 Node.js-based test suite (see TestingMechanism) - !! `serve`: serves tw5.com ``` @@ -66,15 +48,7 @@ Or: This script serves the `tw5.com-server` edition content with LazyLoading applied to images. -!! `wbld`: builds TiddlyWiki for TiddlyWeb - -This script builds and deploys the code for [[TiddlyWiki in the Sky for TiddlyWeb]]. If you want to experiment with your own builds of TiddlyWiki5 for TiddlyWeb you could use this batch file as a base. - !! `2bld`: builds TiddlyWiki 2.6.5 This script builds TiddlyWiki 2.6.5 from the original source and then displays the differences between them (`diff` is used for *nix, `fc` for Windows). -!! `deploy` & `verbump`: deploy TiddlyWiki and bump the TiddlyWiki version number - -These scripts are concerned with releasing a new version of TiddlyWiki. See [[Releasing a new version of TiddlyWiki5]]. -