Permalink
Browse files

documentation updates; version 0.1.1

  • Loading branch information...
1 parent 0580318 commit e2d0afc97297b32b7ab5a8c6aa40edd9b4193322 @technomancy committed Jul 26, 2008
Showing with 47 additions and 40 deletions.
  1. +6 −0 History.txt
  2. +21 −19 README.rdoc
  3. +3 −7 Rakefile
  4. +6 −1 bin/conspire
  5. +5 −5 conspire.gemspec
  6. +1 −1 lib/conspire.rb
  7. +5 −7 lib/conspire/support/conspire.el
View
@@ -1,3 +1,9 @@
+=== 0.1.1 / 2008-07-25
+
+* Fixed a bug where empty repositories would not sync.
+* Lower sync intervals by default.
+* Emacs support works on a per-buffer basis.
+
=== 0.1.0 / 2008-07-24
* Nearly usable! Sorta-works!
View
@@ -1,6 +1,7 @@
= conspire
- by Phil Hagelberg (C) 2008
- http://conspire.rubyforge.org
+
+(C) 2008 Phil Hagelberg
+http://github.com/technomancy/conspire
Conspire is a real-time collaborative editing platform using Git as a
transport layer.
@@ -21,17 +22,17 @@ Once prerequisites are met:
== Usage
Conspiracy sessions operate around repositories rather than single
-files like other collaborative editors. So launch +conspire+ with a
-directory as its first argument to have it initialize a repository in
-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,
-install conspire.el and then visit the file you want to edit and
-pressing M-x conspire-mode.
+files like other collaborative editors. See lib/conspire/support to
+see which editors are supported. In Emacs, first install conspire.el,
+then visit the file you want to edit and invoke M-x conspire-mode.
Repository history is cleared in between conspiracy sessions.
+You can manually use conspire if you want to try it out without an
+editor. Just launch +conspire+ with a directory as its only argument,
+and it will initialize a new git repository in there and launch a
+conspiracy session.
+
For testing purposes, you can run two or more conspiracies on the same
machine; you just have to specify an alternate port and name for the
others. Names should always include the string "conspiracy" to
@@ -45,25 +46,26 @@ Set the DEBUG environment variable to get more information on the console.
* Conflict resolution remains entirely unhandled.
+* Emacs is the only supported editor; see below.
+
* When using Avahi for your ZeroConf implementation, you will not be
able to do anything unless you have an active network connection. So
disconnected conspirancy sessions are not possible without bringing
up an ad-hoc network to trick Avahi into activating. You'll also see
a big fat warning, which should be ignored.
-== Editor Support
+== Contributing
+
+Patches are welcome via github or email. Adding support for more
+editors would probably be the most useful contributions, though
+anything is appreciated.
Editors must support:
* Saving on an interval
* Committing files to the repo
* Refreshing internal buffers
-Edits should not be allowed in between these steps.
-
-Editors may be able to support launching the +conspire+ executable for
-added convenience.
-
-That's about all there is to it. If your favourite editor is not
-supported, please fork and add support for it; it's really not a
-difficult task.
+Edits should not be allowed in between these steps. Editors may be
+able to support launching the +conspire+ executable for added
+convenience.
View
@@ -7,17 +7,13 @@ require './lib/conspire.rb'
Hoe.new('conspire', Conspire::VERSION) do |p|
p.developer('Phil Hagelberg', 'technomancy@gmail.com')
+ # TODO: tell flog about README.rdoc instead of README.txt
p.summary = 'Conspire is a real-time collaborative editing platform using Git as a transport layer.'
- p.url = 'http://conspire.rubyforge.org'
+ p.url = 'http://github.com/technomancy/conspire'
+ # TODO: release on rubyforge once all our required dependency versions make it to rubyforge
p.extra_deps << ['technomancy-gitjour', '6.3.0']
p.extra_deps << 'clip'
end
-desc "Code statistics"
-task :stats do
- require 'code_statistics'
- CodeStatistics.new(['lib'], ['Unit tests', 'test']).to_s
-end
-
# vim: syntax=Ruby
View
@@ -11,7 +11,12 @@ options = Clip do |c|
:default => Conspire::DEFAULTS[:name])
end
-abort options.to_s if !options.valid?
+# TODO: show usage message on --help
+if !options.valid?
+ puts "Conspire is a git-based collaboration platform."
+ puts " You generally interact use it via an editor; see README for details."
+ abort options.to_s
+end
Conspire.start ARGV.first, options
Thread.new { Conspire.discover_loop }
View
@@ -1,17 +1,17 @@
Gem::Specification.new do |s|
s.name = %q{conspire}
- s.version = "0.1.0"
+ s.version = "0.1.1"
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
s.authors = ["Phil Hagelberg"]
- s.date = %q{2008-07-24}
+ s.date = %q{2008-07-25}
s.default_executable = %q{conspire}
s.email = ["technomancy@gmail.com"]
s.executables = ["conspire"]
s.extra_rdoc_files = ["History.txt", "Manifest.txt"]
- s.files = ["COPYING", "History.txt", "Manifest.txt", "README.rdoc", "Rakefile", "bin/conspire", "lib/conspire.rb", "lib/conspire/conspirator.rb", "lib/conspire/gitjour_exts.rb", "lib/conspire/support/conspire.el", "test/perf.rb", "test/test_conspire.rb"]
+ s.files = ["COPYING", "History.txt", "Manifest.txt", "README.rdoc", "Rakefile", "bin/conspire", "conspire.gemspec", "lib/conspire.rb", "lib/conspire/conspirator.rb", "lib/conspire/gitjour_exts.rb", "lib/conspire/support/conspire.el", "test/perf.rb", "test/test_conspire.rb"]
s.has_rdoc = true
- s.homepage = %q{http://conspire.rubyforge.org}
+ s.homepage = %q{http://github.com/technomancy/conspire}
s.rdoc_options = ["--main", "README.txt"]
s.require_paths = ["lib"]
s.rubyforge_project = %q{conspire}
@@ -37,4 +37,4 @@ Gem::Specification.new do |s|
s.add_dependency(%q<clip>, [">= 0"])
s.add_dependency(%q<hoe>, [">= 1.7.0"])
end
-end
+end
View
@@ -8,7 +8,7 @@
require File.dirname(__FILE__) + '/conspire/conspirator'
module Conspire
- VERSION = '0.1.0'
+ VERSION = '0.1.1'
# TODO: play with optimal intervals; perhaps auto-adjust based on latency?
DEFAULTS = { :port => 7456, :name => 'conspiracy', :sync_interval => 0.25 }
HOSTNAME = `hostname`.chomp # TODO: is there a better way?
@@ -3,7 +3,7 @@
;; Copyright (C) 2008 Phil Hagelberg
;; Author: Phil Hagelberg <technomancy@gmail.com>
-;; URL: http://conspire.rubyforge.org
+;; URL: http://github.com/technomancy/conspire
;; Version: 0.2
;; Created: 2008-07-22
;; Keywords: collaboration
@@ -37,12 +37,10 @@
;;
;; (autoload 'conspire-mode "conspire" "Collaborative editing" t)
-;;; TODO:
-
-;; For some reason conspire-sync-buffer only runs on cursor movement
-;; Gracefully kill shell process so it can clean up
-;; Don't bother with *Async Shell Command* output buffer
-;; Color lines based on which conspirator wrote them?
+;; TODO: For some reason conspire-sync-buffer only runs on cursor movement
+;; TODO: Gracefully kill shell process so it can clean up
+;; TODO: Don't bother with *Async Shell Command* output buffer
+;; TODO: Color lines based on which conspirator wrote them?
;;; Code:

0 comments on commit e2d0afc

Please sign in to comment.