diff --git a/editions/tw5.com/tiddlywiki.info b/editions/tw5.com/tiddlywiki.info index 7b97d37a6..157f8ce80 100644 --- a/editions/tw5.com/tiddlywiki.info +++ b/editions/tw5.com/tiddlywiki.info @@ -40,7 +40,7 @@ "--rendertiddler","ReadMe","readme.md","text/html", "--rendertiddler","ReadMeBinFolder","bin/readme.md","text/html", "--rendertiddler","ContributingTemplate","contributing.md","text/html", - "--rendertiddler","$:/core/copyright.txt","licenses/copyright.md","text/plain"], + "--rendertiddler","$:/core/copyright.txt","license.md","text/plain"], "tw2": [ "--rendertiddler","TiddlyWiki2ReadMe","tw2/readme.md","text/html"], "static": [ diff --git a/licenses/copyright.md b/license.md similarity index 100% rename from licenses/copyright.md rename to license.md diff --git a/readme.md b/readme.md index f0de6bc89..c2a68030b 100644 --- a/readme.md +++ b/readme.md @@ -1,4 +1,4 @@ -

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
  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: