SparkleShare/README

SparkleShare 0.2 Beta 2
=======================

SparkleShare is a file sharing and collaboration tool inspired by Dropbox. 

SparkleShare isn't just a piece of software, it's part of your workflow. It's 
designed to make sharing documents and collaboration easier, and to make peers 
aware of what you are doing. It allows you to instantly sync with any Git 
repository you have access to. The user interface and features are made to 
support this goal. Though SparkleShare is not made to be a graphical frontend 
for git or a backup tool, it may be useful for other kinds of purposes as well, 
like backing up small files or monitoring your favourite project. In contrast 
to the projects name, we will very likely refuse to implement your personal 
ponies.

SparkleShare currently only works on Linux/GNOME.
Windows and OSX ports are planned for the future.


License
=======

SparkleShare is free software and licensed under the GNU GPLv3. You are welcome 
to change and redistribute it under certain conditions. For more information 
see the LICENSE file or visit http://www.gnu.org/licenses/gpl-3.0.html


Run on Linux:
=============

SparkleShare currently requires:

   - git >= 1.7
   - gtk-sharp2 >= 2.12.7
   - mono-core >= 2.2
   - ndesk-dbus >= 0.6
   - openssh
   - gvfs >= 1.3
   - intltool
   - libnotify
   - nautilus-python
   - pygtk
   - webkitgtk
   - webkit-sharp

Run the service, either click the SparkleShare launcher or:

   $ sparkleshare start

You can stop the service via the graphical interface or by typing:

   $ sparkleshare stop

For help:

   $ sparkleshare --help

Note:

   SparkleShare creates its own RSA keypair in ~/.ssh and uses that for
   authentication. Please mind this if you're planning to set up your own server 
   by hand.


Build on Linux:
===============

To build SparkleShare you need:

   - gtk-sharp2-devel >= 2.12.7
   - mono-core >= 2.2
   - mono-devel >= 2.2
   - monodevelop >= 2.0
   - ndesk-dbus-devel >= 0.6
   - ndesk-dbus-glib-devel >= 0.6
   - nautilus-python-devel
   - nant
   - notify-sharp-devel
   - webkit-sharp-devel

You can build and install SparkleShare like this:

   $ ./configure (or ./autogen if you got SparkleShare from the repository)
   $ make
   $ sudo make install

Note:

   Use './configure --prefix=/usr' if you want the Nautilus extension to work.


Run on Mac:
===========

You will need to have the Mac version of git installed.

SparkleShare will look for git in /usr/bin, so you may need to create a symbolic
link to git, depending on where it was installed:

   $ sudo ln -s /path/to/your/git /usr/bin/git

Now just double-click the SparkleShare.app.


Build on Mac:
=============

Install the Mono Framework, Monodevelop (plus the MonoMac plugin), and MacPorts.

Install git-core, automake and intltool using 'port install'.
Make sure that git or a symbolic link to git is in /usr/bin.

Note:

   You may need to adjust some environment variables to find mono:

   $ export PKG_CONFIG=/Library/Frameworks/Mono.framework/Versions/Current/bin/pkg-config
   $ export PKG_CONFIG_PATH=/Library/Frameworks/Mono.framework/Versions/Current/lib/pkgconfig

Open 'SparkleShare/Mac/SparkleShare.sln' in MonoDevelop and start the build.


Frequently Asked Question
=========================

Q: Why is it written in Mono/C#?
A: Because I hate freedom.


Info
====

Official website:
http://www.sparkleshare.org/

Project page:
http://github.com/SparkleShare/

IRC Channel:
#sparkleshare on irc.gnome.org

Wiki:
http://github.com/hbons/SparkleShare/wiki/

Issue tracker:
http://github.com/hbons/SparkleShare/issues/

Translation project:
http://www.transifex.net/projects/p/sparkleshare/


Now have fun and create cool things together! :)