Here are some notes on what I do to create a new tw5 plugin using github. 
This includes build instructions that I use on a linux machine. It should 
be the same or similar with the mac and maybe the same if you use cygwin on 
the pc.

First read the stuff on tiddlywiki.com - 
http://tiddlywiki.com/static/PluginMechanism.html 
and install node.js and git.

Note that in github all your repositories must live in your 'root' dir - 
you cannot organise stuff with dirs. I now prepend 'TW5-' to my tiddlywiki5 
projects to group them together by name.

Go to github create new repo TW5-myplugin
choose a location in your filesystem (eg TW5) for a tw5 project issue  
commands:
mkdir TW5
git clone https://github.com/Jermolene/TiddlyWiki5.git TW5
cd TW5
cd plugins
mkdir myorg
cd myorg
git clone https://github.com/mygithub/TW5-myplugin.git myplugin
cd myplugin
git status
--now created you files--  note that tw5 javascript files contain an inital 
'comment' which includes a title that determines the name of the tiddler 
that will contain the source eg "title: $:/plugins/bj/Dev/trace.js" 

include the file
plugin.info (see https://github.com/buggyj/TW5-Dev.git for an example)

BUILDING (my way)
I use a build dir within my plugin source so that I can build a 'demo.html' 
of the plugin. This dir can be copied from 
https://github.com/buggyj/TW5-Dev.git, you will need to modify the file
plugins/myorg/myplugin/build/demo/tiddlywiki.info
to include a reference  your plugin dir instead of 'Dev'
cd to TW5/plugins/myorg/myplugin/build/
type
./bld.sh

BUILDING (modify tiddlywiki5 files)
Modify editions/tw5.com/tiddlywiki.info to include a reference to your 
plugin dir.
>From the root of your TW5 tree  issue command

./qbld.sh

the resultant file (index.html or demo.html) ends up in dir 
"../jermolene.github.com" relative to TW5/

SAVE TO GITHUB
>From plugins/myorg/myplugin/build/ issue commands 
--for first checkin add all files--
git add -A 
--commit to your local repository---
git commit -am "something meaningful about this check in"
--copy local changes to github--
git push

It is possible to add tags (as TW5 does) for releases

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

Reply via email to