diff --git a/editions/tw5.com/tiddlers/readme/ReadMe.tid b/editions/tw5.com/tiddlers/readme/ReadMe.tid index 5e552568d..be735f3fc 100644 --- a/editions/tw5.com/tiddlers/readme/ReadMe.tid +++ b/editions/tw5.com/tiddlers/readme/ReadMe.tid @@ -2,7 +2,6 @@ title: ReadMe tags: introduction \define tw-wikilinks() no - ! Welcome to TiddlyWiki5 {{HelloThere}} diff --git a/readme.md b/readme.md index ed19c6179..59f477220 100644 --- a/readme.md +++ b/readme.md @@ -1,67 +1,67 @@

-Welcome to -TiddlyWiki5

+Welcome to +TiddlyWiki5

-Welcome to -TiddlyWiki5, a reboot of -TiddlyWiki, the reusable non-linear personal web notebook -first released in 2004. It is a complete interactive wiki in -JavaScript that can be run from a single HTML file in the browser or as a powerful -node.js application.

- -TiddlyWiki is designed to fit around your brain, giving you a better way of managing information than traditional documents and emails. The fundamental idea is that information is more useful and reusable if we cut it up into the smallest semantically meaningful chunks – -tiddlers – and give them titles so that they can be structured with links, tags and macros. -TiddlyWiki aims to provide a fluid interface for working with tiddlers, allowing them to be aggregated and composed into longer narratives.

- -TiddlyWiki5 has many -improvements over the original. It is currently labelled alpha, meaning it is working but incomplete. It is a great time to get involved and support its -future development. You can:

-Getting started with -TiddlyWiki under node.js

+Explore its features online at +http://five.tiddlywiki.com/
  • +Get involved in the +development on GitHub
  • +Join the discussions on +the TiddlyWikiDev Google Group
  • +Follow +@TiddlyWiki on Twitter for the latest news
  • +Learn how to +help the TiddlyWiki project and community
  • +Getting started with +TiddlyWiki under node.js

    - -TiddlyWiki5 can be used on the command line to perform an extensive set of operations based on tiddlers, -TiddlerFiles and -TiddlyWikiFiles. For example, this loads the tiddlers from a -TiddlyWiki HTML file and then saves one of them in HTML:

    +
    +TiddlyWiki5 can be used on the command line to perform an extensive set of operations based on tiddlers, 
    +TiddlerFiles and 
    +TiddlyWikiFiles. For example, this loads the tiddlers from a 
    +TiddlyWiki HTML file and then saves one of them in HTML:

     node tiddlywiki.js --verbose --load mywiki.html --savetiddler ReadMe ./readme.html

    Usage

    Running -tiddlywiki.js 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.

    +tiddlywiki.js 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 wiki directory 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 --.

     node tiddlywiki.js [<wikipath>] [--<command> [<arg>[,<arg>]]]

    Batch Files

    -For trying -TiddlyWiki5 out under node.js, several batch files are provided:

      +For trying +TiddlyWiki5 out under node.js, several batch files are provided:

      • -bld.sh builds the new -TiddlyWiki 5 HTML file
      • +bld.sh builds the new +TiddlyWiki 5 HTML file
      • -2bld.sh builds -TiddlyWiki 2.6.5 from its original source

      +2bld.sh builds +TiddlyWiki 2.6.5 from its original source

    Commands

    The following commands are available:

    - -DumpCommand

    + +DumpCommand

    dump tiddlers

    @@ -79,12 +79,12 @@ Dump the current core configuration

     
     

    - -LoadCommand

    + +LoadCommand

    -Load tiddlers from 2.x.x -TiddlyWiki files ( +Load tiddlers from 2.x.x +TiddlyWiki files ( .html), .tiddler, .tid, @@ -93,19 +93,19 @@ TiddlyWiki files (

    - -SaveTiddlerCommand

    + +SaveTiddlerCommand

    -Save an individual tiddler as a specified -ContentType, defaults to +Save an individual tiddler as a specified +ContentType, defaults to text/html

     --savetiddler <title> <filename> [<type>]

    - -ServerCommand

    + +ServerCommand

    The server is very simple. At the root, it serves a rendering of a specified tiddler. Away from the root, it serves individual tiddlers encoded in JSON, and supports the basic HTTP operations for @@ -129,8 +129,8 @@ servetype - the content type with which the root tiddler should be serv

    - -VerboseCommand

    + +VerboseCommand

    Triggers verbose output, useful for debugging

    @@ -138,14 +138,14 @@ Triggers verbose output, useful for debugging 

     
     

    - -VersionCommand

    + +VersionCommand

    -Displays the version number of -TiddlyWiki.

    +Displays the version number of 
    +TiddlyWiki.

     --version

    -This readme file was automatically generated by -TiddlyWiki5 +This readme file was automatically generated by +TiddlyWiki5

    \ No newline at end of file