diff --git a/bin/readme.md b/bin/readme.md index c611d2b7b..28064f02d 100644 --- a/bin/readme.md +++ b/bin/readme.md @@ -1,3 +1,3 @@ -

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
+
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.
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/contributing.md b/contributing.md
index 854f9db9c..e307ea6da 100644
--- a/contributing.md
+++ b/contributing.md
@@ -1,4 +1,4 @@
-
Contributing to TiddlyWiki5
We welcome contributions to the code and documentation of TiddlyWiki in several ways:
There are other ways to help TiddlyWiki too.
Contributor License Agreement
Like other OpenSource projects, TiddlyWiki5 needs a signed contributor license agreement from individual contributors. This is a legal agreement that allows contributors to assert that they own the copyright of their contribution, and that they agree to license it to the UnaMesa Association (the legal entity that owns TiddlyWiki on behalf of the community).
How to sign the CLA
Create a GitHub pull request to add your name to cla-individual.md or cla-entity.md, with the date in the format (YYYY/MM/DD).
step by step
  1. Navigate to licenses/CLA-individual or licenses/CLA-entity according to whether you are signing as an individual or representative of an organisation
  2. Click the "edit" button at the top-right corner (clicking this button will fork the project so you can edit the file)
  3. Add your name at the bottom
    • eg: Jeremy Ruston, @Jermolene, 2011/11/22
  4. Below the edit box for the CLA text you should see a box labelled Propose file change
  5. Enter a brief title to explain the change (eg, "Signing the CLA")
  6. Click the green button labelled Propose file change
  7. On the following screen, click the green button labelled Create pull request
The CLA documents used for this project were created using Harmony Project Templates. "HA-CLA-I-LIST Version 1.0" for "CLA-individual" and "HA-CLA-E-LIST Version 1.0" for "CLA-entity".
Remarks
+
Contributing to TiddlyWiki5
We welcome contributions to the code and documentation of TiddlyWiki in several ways:
There are other ways to help TiddlyWiki too.
Contributor License Agreement
Like other OpenSource projects, TiddlyWiki5 needs a signed contributor license agreement from individual contributors. This is a legal agreement that allows contributors to assert that they own the copyright of their contribution, and that they agree to license it to the UnaMesa Association (the legal entity that owns TiddlyWiki on behalf of the community).
How to sign the CLA
Create a GitHub pull request to add your name to cla-individual.md or cla-entity.md, with the date in the format (YYYY/MM/DD).
step by step
  1. Navigate to licenses/CLA-individual or licenses/CLA-entity according to whether you are signing as an individual or representative of an organisation
  2. Click the "edit" button at the top-right corner (clicking this button will fork the project so you can edit the file)
  3. Add your name at the bottom
    • eg: Jeremy Ruston, @Jermolene, 2011/11/22
  4. Below the edit box for the CLA text you should see a box labelled Propose file change
  5. Enter a brief title to explain the change (eg, "Signing the CLA")
  6. Click the green button labelled Propose file change
  7. On the following screen, click the green button labelled Create pull request
The CLA documents used for this project were created using Harmony Project Templates. "HA-CLA-I-LIST Version 1.0" for "CLA-individual" and "HA-CLA-E-LIST Version 1.0" for "CLA-entity".
Remarks
 ----—
In this case, please clearly state so, since otherwise we assume that you are the legal copyright holder of the contributed work! Please provide links and additional information that clarify under which license the rest of the code is distributed.
 
This file was automatically generated by TiddlyWiki5
 

\ No newline at end of file
diff --git a/readme.md b/readme.md
index 0a18f611d..f0de6bc89 100644
--- a/readme.md
+++ b/readme.md
@@ -1,8 +1,8 @@
-
Welcome to TiddlyWiki, a non-linear personal web notebook that anyone can use and keep forever, independently of any corporation.
TiddlyWiki is a complete interactive wiki in JavaScript. It can be used as a single HTML file in the browser or as a powerful Node.js application. It is highly customisable: the entire user interface is itself implemented in hackable WikiText.
Learn more and see it in action at http://tiddlywiki.com/
Developer documentation is in progress at http://tiddlywiki.com/dev/
Installing TiddlyWiki on Node.js
  1. Install Node.js
    • either from your favourite package manager: typically apt-get install nodejs on Debian/Ubuntu Linux or Termux for Android, or brew install node on a Mac
    • or directly from http://nodejs.org
  2. Open a command line terminal and type:
    npm install -g tiddlywiki
    If it fails with an error you may need to re-run the command as an administrator:
    sudo npm install -g tiddlywiki (Mac/Linux)
  3. Check TiddlyWiki is installed by typing:
    tiddlywiki --version
  4. In response, you should see TiddlyWiki report its current version (eg "5.1.11"; you may also see other debugging information reported)
  5. Try it out:
    1. tiddlywiki mynewwiki --init server to create a folder for a new wiki that includes server-related components
    2. tiddlywiki mynewwiki --server to start TiddlyWiki
    3. Visit http://127.0.0.1:8080/ in your browser
    4. Try editing and creating tiddlers
  6. Optionally, make an offline copy:
    • click the 
+
      Welcome to TiddlyWiki, a non-linear personal web notebook that anyone can use and keep forever, independently of any corporation.
      TiddlyWiki is a complete interactive wiki in JavaScript. It can be used as a single HTML file in the browser or as a powerful Node.js application. It is highly customisable: the entire user interface is itself implemented in hackable WikiText.
      Learn more and see it in action at http://tiddlywiki.com/
      Developer documentation is in progress at http://tiddlywiki.com/dev/
      Installing TiddlyWiki on Node.js
      1. Install Node.js
        • either from your favourite package manager: typically apt-get install nodejs on Debian/Ubuntu Linux or Termux for Android, or brew install node on a Mac
        • or directly from http://nodejs.org
      2. Open a command line terminal and type:
        npm install -g tiddlywiki
        If it fails with an error you may need to re-run the command as an administrator:
        sudo npm install -g tiddlywiki (Mac/Linux)
      3. Check TiddlyWiki is installed by typing:
        tiddlywiki --version
      4. In response, you should see TiddlyWiki report its current version (eg "5.1.12"; you may also see other debugging information reported)
      5. Try it out:
        1. tiddlywiki mynewwiki --init server to create a folder for a new wiki that includes server-related components
        2. tiddlywiki mynewwiki --server to start TiddlyWiki
        3. Visit http://127.0.0.1:8080/ in your browser
        4. Try editing and creating tiddlers
      6. Optionally, make an offline copy:
        • click the 
     
         
     
- save changes button in the sidebar, OR
        • tiddlywiki --build index
      The -g flag causes TiddlyWiki to be installed globally. Without it, TiddlyWiki will only be available in the directory where you installed it.
      If you are using Debian or Debian-based Linux and you are receiving a node: command not found error though node.js package is installed, you may need to create a symbolic link between nodejs and node. Consult your distro's manual and whereis to correctly create a link. See github issue 1434
      Example Debian v8.0: sudo ln -s /usr/bin/nodejs /usr/bin/node
+ save changes button in the sidebar, OR
    • tiddlywiki --build index
The -g flag causes TiddlyWiki to be installed globally. Without it, TiddlyWiki will only be available in the directory where you installed it.
If you are using Debian or Debian-based Linux and you are receiving a node: command not found error though node.js package is installed, you may need to create a symbolic link between nodejs and node. Consult your distro's manual and whereis to correctly create a link. See github issue 1434
Example Debian v8.0: sudo ln -s /usr/bin/nodejs /usr/bin/node
 
Using TiddlyWiki on Node.js
TiddlyWiki5 can be used on the command line to perform an extensive set of operations based on TiddlyWikiFolders, TiddlerFiles and TiddlyWikiFiles.
For example, the following command loads the tiddlers from a TiddlyWiki HTML file and then saves one of them in static HTML:
tiddlywiki --verbose --load mywiki.html --rendertiddler ReadMe ./readme.html
Running tiddlywiki from the command line boots the TiddlyWiki kernel, loads the core plugins and establishes an empty wiki store. It then sequentially processes the command line arguments from left to right. The arguments are separated with spaces.
The first argument is the optional path to the TiddlyWikiFolder to be loaded. If not present, then the current directory is used.
The commands and their individual arguments follow, each command being identified by the prefix --.
tiddlywiki [<wikipath>] [--<command> [<arg>[,<arg>]]]
The available commands are: