SparkleShare/README.md

# [SparkleShare](https://www.sparkleshare.org/)

[SparkleShare](https://www.sparkleshare.org/) is a file sharing and collaboration app. It works just like Dropbox, and you can run it on your own server. It's available for Linux distributions, macOS, and Windows. [Support the project on Patreon](https://www.patreon.com/SparkleShare).

![Banner](https://raw.githubusercontent.com/hbons/SparkleShare/master/SparkleShare/Common/Images/readme-banner.png)


## 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.


## Set up a host

Under the hood SparkleShare uses the version control system [Git](https://git-scm.com/) and the large files extension [Git LFS](https://git-lfs.github.com), 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 we recommend hosting a [GitLab Community Edition](https://about.gitlab.com/installation/) instance.

## Build from source
`SparkleShare` is Free and Open Source software and licensed under the [GNU GPLv3 or later](legal/License_for_SparkleShare.txt). You are welcome to change and redistribute it under certain conditions. Its library `Sparkles` is licensed under the [GNU LGPLv3 or later](legal/License_for_Sparkles.txt).

Here are instructions to build SparkleShare on [Linux distributions](SparkleShare/Linux/README.md), [macOS](SparkleShare/Mac/README.md), and [Windows](SparkleShare/Windows/README.md).

Note: on some Linux distributions you'll need the TopIcons extension for GNOME Shell to show the SparkleShare status icon.

[![Build Status](https://travis-ci.org/hbons/SparkleShare.svg?branch=master)](https://travis-ci.org/hbons/SparkleShare)
[![Join the chat at https://gitter.im/hbons/SparkleShare](https://badges.gitter.im/hbons/SparkleShare.svg)](https://gitter.im/hbons/SparkleShare?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

## Useful links
- [sparkleshare.org](https://www.sparkleshare.org/)
- [@SparkleShare](https://www.twitter.com/SparkleShare), [@hbons](https://www.twitter.com/hbons)
- Community chatroom on [Gitter](https://www.gitter.im/hbons/SparkleShare)
- [Wiki](https://www.github.com/hbons/SparkleShare/wiki)


Have fun, make awesome. :)
readme: HTTPS website links 2016-07-09 21:23:03 +00:00			`# [SparkleShare](https://www.sparkleshare.org/)`
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. 2011-12-04 19:56:23 +00:00
Update README.md 2017-03-18 17:43:01 +00:00			`[SparkleShare](https://www.sparkleshare.org/) is a file sharing and collaboration app. It works just like Dropbox, and you can run it on your own server. It's available for Linux distributions, macOS, and Windows. [Support the project on Patreon](https://www.patreon.com/SparkleShare).`
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. 2011-12-04 19:56:23 +00:00
Update README.md 2017-03-18 14:12:26 +00:00			`![Banner](https://raw.githubusercontent.com/hbons/SparkleShare/master/SparkleShare/Common/Images/readme-banner.png)`
Add Bountysource badge to README Because you have some open bounties, we thought you might want to display this badge in your README! 2014-06-16 22:26:02 +00:00
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. 2011-12-04 19:56:23 +00:00
Rearrange README.md 2015-07-07 23:28:42 +00:00			`## How does it work?`
README: Move info section up 2012-03-09 21:06:02 +00:00
Rearrange README.md 2015-07-07 23:28:42 +00:00			`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.`
update Windows section of README 2012-03-06 22:56:32 +00:00
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. 2011-12-04 19:56:23 +00:00
Update README.md 2017-03-18 14:15:41 +00:00			`## Set up a host`
update README with info on how to reset settings 2012-03-09 20:55:15 +00:00
Update README.md 2017-09-10 14:25:57 +00:00			Under the hood SparkleShare uses the version control system [Git](https://git-scm.com/) and the large files extension [Git LFS](https://git-lfs.github.com), 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 we recommend hosting a [GitLab Community Edition](https://about.gitlab.com/installation/) instance.
Simplify README.md 2012-06-19 17:28:49 +00:00
readme: Move Linux git mention 2017-09-09 15:19:41 +00:00			`## Build from source`
Update README.md 2017-03-18 14:16:45 +00:00			`SparkleShare` is Free and Open Source software and licensed under the [GNU GPLv3 or later](legal/License_for_SparkleShare.txt). You are welcome to change and redistribute it under certain conditions. Its library `Sparkles` is licensed under the [GNU LGPLv3 or later](legal/License_for_Sparkles.txt).
Rearrange README.md 2015-07-07 23:28:42 +00:00
readme: Move Linux git mention 2017-09-09 15:19:41 +00:00			`Here are instructions to build SparkleShare on [Linux distributions](SparkleShare/Linux/README.md), [macOS](SparkleShare/Mac/README.md), and [Windows](SparkleShare/Windows/README.md).`
Rearrange README.md 2015-07-07 23:28:42 +00:00
readme: Add note for status icon 2018-02-21 16:47:01 +00:00			`Note: on some Linux distributions you'll need the TopIcons extension for GNOME Shell to show the SparkleShare status icon.`

Update README.md 2017-03-18 14:12:26 +00:00			`[![Build Status](https://travis-ci.org/hbons/SparkleShare.svg?branch=master)](https://travis-ci.org/hbons/SparkleShare)`
Update README.md 2018-02-14 19:33:11 +00:00			`[![Join the chat at https://gitter.im/hbons/SparkleShare](https://badges.gitter.im/hbons/SparkleShare.svg)](https://gitter.im/hbons/SparkleShare?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)`
update README with info on how to reset settings 2012-03-09 20:55:15 +00:00
Rearrange README.md 2015-07-07 23:36:35 +00:00			`## Useful links`
Update README.md 2018-02-14 19:33:11 +00:00			`- [sparkleshare.org](https://www.sparkleshare.org/)`
Update README.md 2018-02-14 19:36:56 +00:00			`- [@SparkleShare](https://www.twitter.com/SparkleShare), [@hbons](https://www.twitter.com/hbons)`
			`- Community chatroom on [Gitter](https://www.gitter.im/hbons/SparkleShare)`
			`- [Wiki](https://www.github.com/hbons/SparkleShare/wiki)`

update README with a more explicit note about the Git dependency. 2013-10-06 16:02:53 +00:00
Simplify README.md 2012-06-19 17:05:56 +00:00			`Have fun, make awesome. :)`
readme: IRC channel no longer active 2017-09-09 15:12:01 +00:00