# Package Syncing

Keep your different Sublime Text installations synchronised across different machines. This idea of the package came by reading the article on [sublime.wbond.net](https://sublime.wbond.net/docs/syncing), so you could use the manual way or simple using this package. 

The package is using a different attempt rather than just build a link. It is basically syncing your user folder and you can define which files you would like to include in the sync. On the other hand you can also exclude files from the sync for example for platform depending settings or packages.

## Functions

- Synchronise your settings, keymaps, builds (adjust able via the settings)
- Automatically install and remove packages between different machines

## Usage

Dropbox is a great choice for syncing settings but other services like Google Drive, or SkyDrive are also working fine. Just pick your personal favourite.

### First Machine

On your first machine you just have to set a proper sync folder and Package Syncing will simply save all selected files in this folder. Just select "Package Syncing: Define Sync Folder" from the command palette and select any directory on your computer, most likely this should be a folder in your Dropbox, GoogleDrive etc.

### Second Machine (or after a fresh installation)

On your second machine please wait until all files are available and then you simple have to set the sync folder and Package Syncing will automatically pull all available files from that folder. This following message dialog should appear which you just have to confirm.

![SyncFolder](https://raw.github.com/wiki/csch0/SublimeText-Package-Syncing/sync_folder.jpg)

After a **restart** of Sublime Text Package Control will check for missing packages and install them automatically. From now on everything should work very smoothly.

### Requirements

In order to use get the benefit of automatic installation of packages across the different machines [Package Control](https://sublime.wbond.net) is basically required.

## Under the Hood

Package Syncing will keep your settings up to date across different machines by checking regular your user and remote directory for updates. The defaults interval is 1 second, if you should have any performance issues you can increase this time via the settings and a restart of Sublime Text.

## Demo

An example sync between two machines; on the top Sublime Text 3 on Windows (as virtual machine) and on the bottom on OS X.

![Example](https://raw.github.com/wiki/csch0/SublimeText-Package-Syncing/example.gif)

## Installation

### Using Package Control:

* Bring up the Command Palette (Command+Shift+P on OS X, Control+Shift+P on Linux/Windows).
* Select Package Control: Install Package.
* Select Package Syncing to install.

### Not using Package Control:

* Save files to the `Packages/Package Syncing` directory, then relaunch Sublime:
  * Linux: `~/.config/sublime-text-2|3/Packages/Package Syncing`
  * Mac: `~/Library/Application Support/Sublime Text 2|3/Packages/Package Syncing`
  * Windows: `%APPDATA%/Sublime Text 2|3/Packages/Package Syncing`

## Donating

Support this project via [gittip][] or [paypal][].

[![Support via Gittip](https://rawgithub.com/csch0/Donation-Badges/master/gittip.jpeg)][gittip] [![Support via PayPal](https://rawgithub.com/csch0/Donation-Badges/master/paypal.jpeg)][paypal]

[gittip]: https://www.gittip.com/csch0
[paypal]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=ZWZCJPFSZNXEW

## License

All files in this package is licensed under the MIT license.

Copyright (c) 2013 Chris <chris@latexing.com>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.