From 4a9e2696d65eed659d6906329197054392825151 Mon Sep 17 00:00:00 2001 From: Luca Dorigo Date: Sat, 1 Dec 2018 15:25:33 +0100 Subject: [PATCH] Promote Gitter Chat in the Readme (#3322) * Promote Gitter Chat in the Readme I'm not sure if it's ok to use inline styles for a small addition like this... also, feel free to change the colors :-) * Added link to Gitter in 'Forums' tiddler and transcluded it in the readme as per @Jermolene comments * Fixed transclusion and built readme * Modified Readme so the 'forums' section is transclued with lower heading levels --- editions/tw5.com/tiddlers/community/Forums.tid | 3 +++ editions/tw5.com/tiddlers/readme/ReadMe.tid | 6 ++++++ readme.md | 5 ++++- 3 files changed, 13 insertions(+), 1 deletion(-) diff --git a/editions/tw5.com/tiddlers/community/Forums.tid b/editions/tw5.com/tiddlers/community/Forums.tid index bca8db1d4..cd10ffe20 100644 --- a/editions/tw5.com/tiddlers/community/Forums.tid +++ b/editions/tw5.com/tiddlers/community/Forums.tid @@ -13,6 +13,8 @@ The ~TiddlyWiki discussion groups are mailing lists for talking about ~TiddlyWik ** An enhanced group search facility is available on [[mail-archive.com|https://www.mail-archive.com/tiddlywiki@googlegroups.com/]] * Watch recordings of our regular [[TiddlyWiki Hangouts]] * Follow [[@TiddlyWiki on Twitter|http://twitter.com/TiddlyWiki]] for the latest news +* ''New: Join us on our live chat at https://gitter.im/TiddlyWiki/public !'' + ! Developers @@ -21,6 +23,7 @@ The ~TiddlyWiki discussion groups are mailing lists for talking about ~TiddlyWik ** An enhanced group search facility is available on [[mail-archive.com|https://www.mail-archive.com/tiddlywikidev@googlegroups.com/]] * Follow [[@TiddlyWiki on Twitter|http://twitter.com/#!/TiddlyWiki]] for the latest news * Get involved in the [[development on GitHub|https://github.com/Jermolene/TiddlyWiki5]] +* Chat at https://gitter.im/TiddlyWiki/public (development room coming soon) New releases of TiddlyWiki, TiddlyDesktop and TiddlyFox are announced via the discussion groups and [[Twitter|https://twitter.com/TiddlyWiki]] (you can also subscribe to an Atom/RSS feed of [[TiddlyWiki releases from GitHub|https://github.com/jermolene/tiddlywiki5/releases.atom]]) diff --git a/editions/tw5.com/tiddlers/readme/ReadMe.tid b/editions/tw5.com/tiddlers/readme/ReadMe.tid index 0a522de97..615b3ab68 100644 --- a/editions/tw5.com/tiddlers/readme/ReadMe.tid +++ b/editions/tw5.com/tiddlers/readme/ReadMe.tid @@ -14,6 +14,12 @@ Learn more and see it in action at https://tiddlywiki.com/ Developer documentation is in progress at https://tiddlywiki.com/dev/ +! Join the Community + +<$vars tv-adjust-heading-level="1"> +<$transclude mode="block" tiddler="Forums"/> + + ! Installing TiddlyWiki on Node.js {{Installing TiddlyWiki on Node.js}} diff --git a/readme.md b/readme.md index 908d3da7a..7540f6f8f 100644 --- a/readme.md +++ b/readme.md @@ -1,4 +1,7 @@ -

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 https://tiddlywiki.com/

Developer documentation is in progress at https://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.16"; 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: