/README

http://github.com/hbons/SparkleShare · #! · 145 lines · 89 code · 56 blank · 0 comment · 0 complexity · df9965c90c6638262060f747edc5e2e1 MD5 · raw file

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