/README

  1# SparkleShare
  2
  3SparkleShare is a collaboration and sharing tool that is designed to keep
  4things simple and to stay out of your way. It allows you to instantly sync
  5with any Git repository you have access to.
  6
  7SparkleShare currently works on Linux and Mac. A Windows port and mobile
  8device support are planned for the future.
  9
 10
 11# License
 12
 13SparkleShare is free software and licensed under the GNU GPLv3 or later. You
 14are welcome to change and redistribute it under certain conditions. For more
 15information see the LICENSE file or visit http://www.gnu.org/licenses/gpl-3.0.html
 16
 17
 18# Run on Linux
 19
 20Requirements:
 21
 22   - git >= 1.7.0
 23   - gtk-sharp2
 24   - gvfs
 25   - intltool
 26   - libnotify
 27   - mono-core >= 2.8
 28   - notify-sharp
 29   - nautilus-python
 30   - openssh
 31   - pygtk
 32   - webkitgtk
 33   - webkit-sharp
 34
 35Run the service, either click the SparkleShare launcher or:
 36
 37   $ sparkleshare start
 38
 39You can stop the service via the graphical interface or by typing:
 40
 41   $ sparkleshare stop
 42
 43For help:
 44
 45   $ sparkleshare --help
 46
 47Note:
 48
 49   SparkleShare creates its own RSA keypair in ~/config/sparkleshare/ and uses 
 50   that for authentication. Please mind this if you're planning to set up your 
 51   own server by hand.
 52
 53
 54# Build on Linux
 55
 56Installing the build dependencies on Debian or Ubuntu:
 57
 58   $ sudo apt-get install gtk-sharp2 mono-runtime mono-devel monodevelop \
 59     libndesk-dbus1.0-cil-dev nant libnotify-cil-dev libgtk2.0-cil-dev mono-gmcs \
 60     libwebkit-cil-dev intltool libtool python-nautilus libndesk-dbus-glib1.0-cil-dev
 61
 62For Ubuntu libappindicator support, run the following before building:
 63
 64   $ sudo apt-get install libappindicator0.1-cil-dev 
 65   
 66On Fedora:
 67
 68   $ sudo yum install gtk-sharp2-devel mono-core mono-devel monodevelop \
 69     ndesk-dbus-devel ndesk-dbus-glib-devel nautilus-python-devel nant \
 70     notify-sharp-devel webkit-sharp-devel webkitgtk-devel libtool intltool \
 71     gnome-doc-utils
 72
 73You can build and install SparkleShare like this:
 74
 75   $ ./configure --prefix=/usr (or ./autogen.sh if you build from the repository)
 76   $ make
 77   $ sudo make install
 78
 79Note:
 80
 81   Use '--prefix=/usr' if you want the Nautilus extension to work.
 82
 83
 84# Run on Mac
 85
 86Just double-click the SparkleShare bundle.
 87
 88
 89# Build on Mac
 90
 91Install Xcode, the Mono Framework, MonoDevelop and the MonoMac plugin (you can find it in MonoDevelop => Add-in Manager).
 92
 93You may need to adjust some environment variables to let the build environment tools find mono:
 94   
 95   $ export PATH=/Library/Frameworks/Mono.framework/Versions/Current/bin:$PATH
 96   $ export PKG_CONFIG=/Library/Frameworks/Mono.framework/Versions/Current/bin/pkg-config
 97   $ export PKG_CONFIG_PATH=/Library/Frameworks/Mono.framework/Versions/Current/lib/pkgconfig
 98
 99Install git, automake, and intltool using MacPorts:
100
101   $ sudo port install git-core automake intltool
102   
103Start the first part of the build:
104
105   $ ./autogen.sh --enable-gtkui=no
106   $ make
107   
108Now that you have compiled the libraries, open 'SparkleShare/Mac/SparkleShare.sln' in
109MonoDevelop and start the build.
110
111To create the SparkleShare.app, make sure the project is focused and select Project from the menu bar 
112and click "Create Mac Installer...". Make sure to select "Don't link assemblies". 
113
114Save the SparkleShare.app somewhere. Paste the contents of 
115the following file in SparkleShare.app/Contents/MonoBundle/config:
116https://raw.github.com/gist/1aeffa61bac73fc08eca/0c0f09ef9e36864c35f34fd5e8bf4f99886be193/gistfile1.txt
117
118Copy /Library/Frameworks/Mono.framework/Versions/Current/lib/libintl.dylib 
119to SparkleShare.app/Contents/Resources
120
121Now you should have a working bundle that you can run.
122
123
124# Info
125
126Official website:
127http://www.sparkleshare.org/
128
129Source code:
130http://github.com/SparkleShare/
131
132IRC Channel:
133#sparkleshare on irc.gnome.org
134
135Wiki:
136http://github.com/hbons/SparkleShare/wiki/
137
138Report issues:
139http://github.com/hbons/SparkleShare/issues/
140
141Translation project:
142http://www.transifex.net/projects/p/sparkleshare/
143
144
145Now have fun and create cool things together! :)