Browse files

better prerequisites documentation

  • Loading branch information...
1 parent c290510 commit 4b5b59f09d288f9d4e32bec9e74f524d81b2b866 @technomancy committed Jul 24, 2008
Showing with 20 additions and 6 deletions.
  1. +12 −5 README.rdoc
  2. +8 −1 lib/conspire/support/conspire.el
@@ -7,9 +7,16 @@ transport layer.
== Installation
-You'll need git 1.5.5 or higher. (sudo gem install roastbeef; roastbeef install git)
+You'll need git 1.5.5 or higher. Ubuntu 8.04 has an older git, but
+MacPorts' version is OK. You'll also need the package
+libavahi-compat-libdnssd-dev on Debian-based systems.
-* sudo gem install technomancy-conspire --source=
+ $ sudo gem install roastbeef; roastbeef install git
+ $ sudo apt-get install libavahi-compat-libdnssd-dev
+Once prerequisites are met:
+ $ sudo gem install technomancy-conspire --source=
== Usage
@@ -20,9 +27,9 @@ that directory. From there you should open up your editor and invoke
conspire from there on the files with which you wish to collaborate.
See lib/conspire/support to see which editors are supported. In Emacs,
-this involves visiting the file you want to edit and pressing M-x
-conspire-mode, though this is still very rough and should be done in
-its own Emacs instance.
+install conspire.el and then visit the file you want to edit and
+pressing M-x conspire-mode, though this is still very rough and should
+be done in its own Emacs instance.
Repository history is cleared in between conspiracy sessions.
@@ -31,13 +31,19 @@
;; Let's use git for real-time collaborative editing!
+;;; Installation:
+;; Copy to your .emacs.d directory and add this to your init file:
+;; (autoload 'conspire-mode "conspire" "Collaborative editing" t)
;;; TODO:
;; In its current state, it's very dangerous to start a conspire
;; session and then switch buffers, since the timer is not yet buffer
;; local. Watch out!
-;; Launch conspire executable.
+;; Automatically launch conspire executable.
;;; Code:
@@ -47,6 +53,7 @@
(defvar conspire-timer nil
"A timer to activate conspire synchronizing.")
(defun conspire-mode ()
"Activate conspire-mode for real-time collaborative editing."

0 comments on commit 4b5b59f

Please sign in to comment.