SparkleShare/README.md

SparkleShare

SparkleShare is a collaboration and sharing tool that is designed to keep things simple and to stay out of your way. It allows you to instantly sync with any Git repository you have access to.

SparkleShare currently works on Linux, Mac and Windows.

License

SparkleShare is free software and licensed under the GNU GPLv3 or later. 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

Running SparkleShare

Note: SparkleShare creates its own RSA keypair in $HOME/.config/sparkleshare/ and uses that for authentication. Please mind this if you're planning to set up your own server by hand.

Linux

You can choose to build from source or get the packages through your distribution's repositories.

Requirements:

curl
git >= 1.7.3
gtk-sharp2
mono-core >= 2.8
notify-sharp
webkit-sharp

Optional:

nautilus-python
gvfs
libappindicator

Mac

Download, unzip and open the SparkleShare bundle.

Windows

Download the installer and run SparkleShare from the start menu.

Building on Linux

Debian or Ubuntu (apt):

$ sudo apt-get install gtk-sharp2 mono-runtime mono-devel monodevelop \
  libndesk-dbus1.0-cil-dev nant libnotify-cil-dev libgtk2.0-cil-dev mono-mcs mono-gmcs \
  libwebkit-cil-dev intltool libtool python-nautilus libndesk-dbus-glib1.0-cil-dev

For Ubuntu libappindicator support, install the following package:

$ sudo apt-get install libappindicator0.1-cil-dev

Fedora (yum):

$ sudo yum install gtk-sharp2-devel mono-core mono-devel monodevelop \
  ndesk-dbus-devel ndesk-dbus-glib-devel nautilus-python-devel nant \
  notify-sharp-devel webkit-sharp-devel webkitgtk-devel libtool intltool

You can then build and install SparkleShare like this:

$ ./configure --prefix=/usr (or ./autogen.sh if you build from the repository)
$ make
$ sudo make install

Note: Use --prefix=/usr if you want the Nautilus extension to work.

Building on Mac

Install Xcode, the Mono Framework, MonoDevelop and the MonoMac plugin (you can find it in MonoDevelop => Add-in Manager).

You may need to adjust some environment variables to let the build environment tools find mono:

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

Install git, automake, and intltool using MacPorts:

$ sudo port install git-core automake intltool

Start the first part of the build:

$ ./autogen.sh --enable-gtkui=no
$ make

Now that you have compiled the libraries, open SparkleShare/Mac/SparkleShare.sln in MonoDevelop and start the build.

Creating a Mac .app

To create the SparkleShare.app, make sure the project is focused and select Project from the menu bar and click "Create Mac Installer...". Make sure to select "Don't link assemblies".

Save the SparkleShare.app somewhere. Copy SparkleShare/Mac/config to SparkleShare.app/Contents/MonoBundle/config (adjust the paths to where you saved the .app):

cp SparkleShare/Mac/config SparkleShare.app/Contents/MonoBundle/config

Copy /Library/Frameworks/Mono.framework/Versions/Current/lib/libintl.dylib to SparkleShare.app/Contents/Resources

Now you should have a working bundle that you can run.

Building on Windows

Install version 4.0 of the .NET Framework if you haven't already.

Install msysGit. Change the install location to C:\msysgit and use the default settings for the other settings during the installation. Copy the C:\msysgit directory into bin\msysgit (in the SparkleShare source directory).

Open a command prompt and execute the following:

cd C:\path\to\SparkleShare\source
cd SparkleShare\Windows
build

C:\path\to\SparkleShare\source\bin should now contain SparkleShare.exe, which you can run.

Note: SparkleShare needs to be run with administrator privileges. Open the properties dialog for SparkleShare.exe and tick the Run this program as an administrator option in the Compatibility tab.

Creating a Windows installer

To create an installer package, install WiX 3.6, restart Windows and run:

build installer

This will create SparkleShare.msi in the same directory.

Reset SparkleShare settings

Linux and Mac:

rm -Rf ~/SparkleShare
rm -Rf ~/.config/sparkleshare

Windows

Remove My Documents\SparkleShare and AppData\Roaming\sparkleshare (AppData is hidden by default).

Info

Official website:	http://www.sparkleshare.org/
Source code:	http://github.com/SparkleShare/
IRC Channel:	#sparkleshare on irc.gnome.org
Wiki:	http://github.com/hbons/SparkleShare/wiki/
Report issues:	http://github.com/hbons/SparkleShare/issues/
Translation project:	http://www.transifex.net/projects/p/sparkleshare/

Now have fun and create cool things together! :)