beenull/SparkleShare
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Rearrange README.md

Browse source
This commit is contained in:
Hylke Bons 2015-07-08 00:28:42 +01:00
parent 5b8f2e7af2
commit 1a2c5872d2
1 changed files with 19 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
README.md
View file

@ -1,42 +1,39 @@
## 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.
[![Bountysource](https://www.bountysource.com/badge/tracker?tracker_id=6747)](https://www.bountysource.com/trackers/6747-sparkleshare?utm_source=6747&utm_medium=shield&utm_campaign=TRACKER_BADGE)
![Banner](https://raw.githubusercontent.com/hbons/SparkleShare/master/SparkleShare/Common/Pixmaps/tutorial-slide-2%402x.png)
### Resources
## How does it work?
| | |
|-------------------:|:--------------------------------------------------|
| **Website**: | http://www.sparkleshare.org/ |
| **Twitter**: | https://www.twitter.com/SparkleShare |
| **Development**: | https://github.com/hbons/SparkleShare |
| **Documentation**: | https://github.com/hbons/SparkleShare/wiki
| **IRC channel**: | #sparkleshare on irc.gnome.org |
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
## Setting up a host
`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 [license](legal/License_for_SparkleShare.txt) file.
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.
The SparkleShare library `SparkleLib` is licensed under the `GNU Lesser General Public License version 3 or later`. For more information see its [license](legal/License_for_SparkleLib.txt) file.
### Setting up a host
## Useful links
[Official Website](http://www.sparkleshare.org/), [Twitter](https://www.twitter.com/SparkleShare), [Wiki](https://www.github.com/hbons/SparkleShare/wiki), and [Source](https://www.github.com/hbons/SparkleShare). Join the chat: #sparkleshare on irc.gnome.org.
## 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).
### Building...
## Compiling from source
[...on Linux distributions](SparkleShare/Linux/README.md)
[...on Mac](SparkleShare/Mac/README.md)
[...on Windows](SparkleShare/Windows/README.md)
SparkleShare bundles Git on Mac and Windows. On Linux distributions you will need to to install the `git` or `git-core` package.
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.
### Finally...
## 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 [legal/License_for_SparkleLib.txt](GNU Lesser General Public License version 3) or later.
## Finally
Have fun, make awesome. :)