]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/git.mdwn
Merge commit 'upstream/master'
[git.ikiwiki.info.git] / doc / git.mdwn
index 4b74a2e0fad3e5de0992621c2c36610f0241e1a9..e7f47f5a02af12099d61a72859c02d699cbd5d8d 100644 (file)
@@ -1,3 +1,46 @@
-Git is a distributed revison control system originally developed for the linux kernel. Ikiki supports storing a wiki in git.
+Ikiwiki, and this documentation wiki, are developed in a git repository and
+can be checked out like this:
 
-(This page needs to be fleshed out with more info.)
\ No newline at end of file
+[[!template id=note text="""
+You can push changes back to ikiwiki's git repository over the `git://`
+transport, to update this wiki, if you'd like, instead of editing it on the
+web. Changes that could not be made via the web will be automatically
+rejected.
+"""]]
+
+       git clone git://git.ikiwiki.info/
+
+Or like this if your firewall only passes http traffic (slow):
+
+       git clone http://git.ikiwiki.info/ikiwiki.git/
+
+The gitweb is [here](http://git.ikiwiki.info/?p=ikiwiki).
+
+There is also a mirror [on github](http://github.com/joeyh/ikiwiki/tree/master).
+
+Commits to this git repository are fed into [CIA](http://cia.vc), and can
+be browsed, subscribed to etc on its
+[project page](http://cia.vc/stats/project/ikiwiki). They're also fed into
+[twitter](http://twitter.com/ikiwiki).
+
+## branches
+
+You are of course free to set up your own ikiwiki git repository with your
+own [[patches|patch]].
+
+Some of the branches included in the main repository include:
+
+* `gallery` contains the [[todo/Gallery]] plugin. It's not yet merged
+  due to license issues.  Also some bits need to be tweaked to make it
+  work with the current *master* branch again.
+* `html` is an unfinished attempt at making ikiwiki output HTML 4.01
+  instead of xhtml.
+* `wikiwyg` adds [[todo/wikiwyg]] support. It is unmerged pending some
+  changes.
+* `darcs` is being used to add darcs support.
+* `pristine-tar` contains deltas that
+  [pristine-tar](http://kitenet.net/~joey/code/pristine-tar)
+  can use to recreate released tarballs of ikiwiki
+* `debian-stable` is used for updates to the old version included in
+  Debian's stable release, and `debian-testing` is used for updates to
+  Debian's testing release.