Thanks for those notes David, much appreciated. I'd welcome pull requests for documentation updates like this,
Best wishes Jeremy On Thu, Sep 12, 2013 at 10:10 AM, David Johnston <[email protected]>wrote: > Firstly this simple walkthough was inspired by a conversation with Tobias > Beer in this post. > https://groups.google.com/forum/#!topic/tiddlywikidev/s20g1snJQTY > > Any detailed advice on how to tackle getting such a plugin up and running >> on the tw5 front is very welcome, e.g. a step 1 to 10 kinda tutorial that >> explains the process roughly outlined with whatever details are rather >> essential. >> > > I realised that someone should have a go at doing this. > > Secondly, I am not a technical writer, so if you find problems please > don't hesitate to comment so I can amend the walkthrough and improve it. > > ---------------------------------------- > > To get started one must first install Node.Js on your computer and > download TW5 from Jeremy's github repository. There are many ways to do > these things, this was the way that worked for me when I tried it. > > 1. Download and install Node.JS from http://nodejs.org/ > 2. If using a Windows computer, download and install github for Windows .. > http://windows.github.com/ or Cygwin ... http://www.cygwin.com/ .. (The > github or cygwin install lets you run the .SH scripts that Jeremy supplies > for building new TW5 plugins and running TW5 as a local server.) > 3. Download the TW5 repository at github using > http://github.com/Jermolene/TiddlyWiki5/archive/master.zip .. (later on > you can use Github properly to do this, but more on using github later > perhaps) > 4. Create a Tiddlywork directory in a place you are comfortable with (I > chose the root of my D: drive) ... such as D:\tiddlywork > 5. Copy the master.zip file you downloaded in step 4. to D:\tiddlywork > 6. Extract the zip file you downloaded into D:\tiddlywork > 7. You should end up with a directory called > D:\tiddlywork\TiddlyWiki5-master\ ... I renamed that to > d:\tiddlywork\TiddlyWiki5 > 8. While in the D:\tiddlywork directory make another folder called > d:\tiddlywork\jermolene.github.com ... you could call this whatever you > want, however that would mean altering some scripts (unadvisable at this > stage). > 9. Go to the start menu and under Node.js, click on *Node.JS command > prompt*. > 10. Move to the D:\tiddlywork\TiddlyWiki5\ Directory using cd > D:\tiddlywork\TiddlyWiki5\ > 11. If github is installed you can then enter* bld.sh* this will build > all the TW5 basic Tiddlywiki's over in ... d:\tiddlywork\ > jermolene.github.com > 12. If using Cygwin then the command to do this is* sh bld.sh* you need > to precede all sh type files with the sh command if using cygwin > 13. To test tw5 in server mode, run *serve.sh* and then go to a browser > and enter http://localhost:8080/ to view a tiddlywiki running as its own > webserver. > > If anyone else would like to test this and report back I can amend or add > to it as required. It is all from memory as I am at work at the moment. > > I will try and add to this with instructions on making your first simple > plugin example walkthrough later on. > > ---------------------------------------- > > -- > You received this message because you are subscribed to the Google Groups > "TiddlyWikiDev" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to [email protected]. > To post to this group, send email to [email protected]. > Visit this group at http://groups.google.com/group/tiddlywikidev. > For more options, visit https://groups.google.com/groups/opt_out. > -- Jeremy Ruston mailto:[email protected] -- You received this message because you are subscribed to the Google Groups "TiddlyWikiDev" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected]. Visit this group at http://groups.google.com/group/tiddlywikidev. For more options, visit https://groups.google.com/groups/opt_out.
