summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAndrew Shadura <andrew.shadura@collabora.co.uk>2015-12-25 18:04:17 +0100
committerAndrew Shadura <andrew.shadura@collabora.co.uk>2015-12-25 18:04:17 +0100
commit2986c09e1e4352b4f0ce694d1c000138c090e8f1 (patch)
treeef73bd4d73637b01d01925eb570c85045b43f2fb /README.md
parent89d5f75065cf2a7e2ca1c122c26a34d7433d120d (diff)
Imported Upstream version 1.5.0
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 15 insertions, 19 deletions
diff --git a/README.md b/README.md
index 2a7dd7b..f029e78 100644
--- a/README.md
+++ b/README.md
@@ -1,38 +1,34 @@
-## SparkleShare
+# SparkleShare
-SparkleShare is an Open Source 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 [Git](http://www.git-scm.org/) repositories and is available for Linux distributions, Mac and Windows.
+SparkleShare is an Open Source collaboration and sharing tool that is designed to keep things simple and to stay out of your way. It's available for Linux distributions, Mac, and Windows.
+![Banner](https://raw.githubusercontent.com/hbons/SparkleShare/master/SparkleShare/Common/Pixmaps/tutorial-slide-2%402x.png)
-### Resources
-| | |
-|-------------------:|:--------------------------------------------------|
-| **Website**: | http://www.sparkleshare.org/ |
-| **Twitter**: | https://www.twitter.com/SparkleShare |
-| **Development**: | https://github.com/hbons/SparkleShare |
-| **IRC channel**: | #sparkleshare on irc.gnome.org |
+## How does it work?
+SparkleShare creates a special folder on your computer. You can add remotely hosted folders (or "projects") to this folder. These projects will be automatically kept in sync with both the host and all of your peers when someone adds, removes or edits a file.
-### License
-SparkleShare is Open Source software and licensed under the `GNU General Public License version 3 or later`. You are welcome to change and redistribute it under certain conditions.For more information see the `legal/License.txt` file.
+## Setting up a host
+SparkleShare uses the version control system [Git](https://git-scm.com/) under the hood, so setting up a host yourself is relatively easy. Using your own host gives you more privacy and control, as well as lots of cheap storage space and higher transfer speeds. We've made a simple [script](https://github.com/hbons/Dazzle) that does the hard work for you. If you need to manage a lot of projects and/or users it may be worth setting up a [GitLab](https://www.gitlabhq.com) instance.
-### Setting up a host
-You can use any host that runs Git. For a simple setup script, check out [Dazzle](https://github.com/hbons/Dazzle). If you need to manage a lot of projects and/or users it may be worth looking at [Gitlab](http://www.gitlabhq.com).
+## Free and Open Source
+`SparkleShare` is Free and Open Source software and licensed under the [GNU General Public License version 3 or later](legal/License_for_SparkleShare.txt). You are welcome to change and redistribute it under certain conditions. Its library `SparkleLib` is licensed under the [GNU Lesser General Public License version 3 or later](legal/License_for_SparkleLib.txt).
-### Building...
+## Compiling from source
-[...on Linux distributions](https://github.com/hbons/SparkleShare/blob/master/SparkleShare/Linux/README.md)
-[...on Mac](https://github.com/hbons/SparkleShare/blob/master/SparkleShare/Mac/README.md)
-[...on Windows](https://github.com/hbons/SparkleShare/blob/master/SparkleShare/Windows/README.md)
+Here are instructions to build SparkleShare on [Linux distributions](SparkleShare/Linux/README.md), [Mac](SparkleShare/Mac/README.md), and [Windows](SparkleShare/Windows/README.md). Make sure to have the `git` package installed when you're building on Linux.
-SparkleShare bundles Git on Mac on Windows. On Linux distributions you will need to to install the `git` or `git-core` package.
+## Useful links
+[Website](http://www.sparkleshare.org/), [Twitter](https://www.twitter.com/SparkleShare), [Wiki](https://www.github.com/hbons/SparkleShare/wiki), and [Source Code](https://www.github.com/hbons/SparkleShare). Join the chat: #sparkleshare on irc.gnome.org.
-### Finally...
+
+## Finally
Have fun, make awesome. :)