From 2f2c42e626c1412397042c45e59ec3c7d0ee0d2f Mon Sep 17 00:00:00 2001 From: Nathan Broadbent Date: Mon, 5 Dec 2011 03:56:23 +0800 Subject: [PATCH] Gave README a Markdown extension so that it's nicely formatted by Github. Added Github Markdown formatting for code blocks and keywords. Turned 'Info' list into an aligned table. --- README | 145 ------------------------------------------------- README.md | 160 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 160 insertions(+), 145 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index bd8cb030..00000000 --- a/README +++ /dev/null @@ -1,145 +0,0 @@ -# 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 and Mac. A Windows port and mobile -device support are planned for the future. - - -# 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 - - -# Run on Linux - -Requirements: - - - git >= 1.7.0 - - gtk-sharp2 - - gvfs - - intltool - - libnotify - - mono-core >= 2.8 - - notify-sharp - - nautilus-python - - openssh - - 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 ~/config/sparkleshare/ and uses - that for authentication. Please mind this if you're planning to set up your - own server by hand. - - -# Build on Linux - -Installing the build dependencies on Debian or Ubuntu: - - $ 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, run the following before building: - - $ sudo apt-get install libappindicator0.1-cil-dev - -On Fedora: - - $ 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 \ - gnome-doc-utils - -You can 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. - - -# Run on Mac - -Just double-click the SparkleShare bundle. - - -# Build 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. - -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. Paste the contents of -the following file in SparkleShare.app/Contents/MonoBundle/config: -https://raw.github.com/gist/1aeffa61bac73fc08eca/0c0f09ef9e36864c35f34fd5e8bf4f99886be193/gistfile1.txt - -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. - - -# 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! :) diff --git a/README.md b/README.md new file mode 100644 index 00000000..d4feb41c --- /dev/null +++ b/README.md @@ -0,0 +1,160 @@ +# 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 and Mac. A Windows port and mobile +device support are planned for the future. + + +## 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 + + +## Run on Linux + +Requirements: + + - git >= 1.7.0 + - gtk-sharp2 + - gvfs + - intltool + - libnotify + - mono-core >= 2.8 + - notify-sharp + - nautilus-python + - openssh + - pygtk + - webkitgtk + - webkit-sharp + +Run the service, either click the SparkleShare launcher or: + +```bash +$ sparkleshare start +``` + +You can stop the service via the graphical interface or by typing: + +```bash +$ sparkleshare stop +``` + +For help: + +```bash +$ sparkleshare --help +``` + +**Note:** + + SparkleShare creates its own RSA keypair in `~/config/sparkleshare/` and uses + that for authentication. Please mind this if you're planning to set up your + own server by hand. + + +## Build on Linux + +### Install build dependencies + +#### Debian or Ubuntu (apt): + +```bash +$ 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 +``` + +#### Fedora (yum): + +```bash +$ 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 \ + gnome-doc-utils +``` + +For Ubuntu `libappindicator` support, install the following package: + +```bash +$ sudo apt-get install libappindicator0.1-cil-dev +``` + +You can then build and install SparkleShare like this: + +```bash +$ ./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. + + +## Run on Mac + +Just double-click the SparkleShare bundle. + + +## Build 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: + +```bash +$ 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: + +```bash +$ sudo port install git-core automake intltool +``` + +Start the first part of the build: + +```bash +$ ./autogen.sh --enable-gtkui=no +$ make +``` + +Now that you have compiled the libraries, open `SparkleShare/Mac/SparkleShare.sln` in +MonoDevelop and start the build. + +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. Paste the contents of +the following file in `SparkleShare.app/Contents/MonoBundle/config`: + +``` +https://raw.github.com/gist/1aeffa61bac73fc08eca/0c0f09ef9e36864c35f34fd5e8bf4f99886be193/gistfile1.txt +``` + +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. + + +## 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! :)