SparkleShare/README.md
helmo 0ed20064d2 Update README.md
Add a link to the Wiki documentation
2014-08-09 15:27:20 +02:00

42 lines
1.8 KiB
Markdown

## 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.
[![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)
### Resources
| | |
|-------------------:|:--------------------------------------------------|
| **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 |
### 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 [license](legal/License.txt) file.
### 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...
[...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.
### Finally...
Have fun, make awesome. :)