Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
MobiusHorizons committed Apr 7, 2015
1 parent e4dafa1 commit f3e1dc7
Showing 1 changed file with 29 additions and 8 deletions.
37 changes: 29 additions & 8 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,33 @@ Synchronization service for linux with plugins for various endpoints hopefully d
more info can be found in the [wiki](https://github.com/MobiusHorizons/syncd/wiki "Wiki")

Build/installation instructions can be found in the INSTALL file or on the wiki
# Building

At the moment, this appears to work:
$ rm -r m4
$ aclocal && autoconf && ./autogen.sh
$ ./configure
$ make
# make install
$ cp rules.json.example ~/.syncd-rules.json #copy sample rules into place
$ vim ~/.syncd-rules.json #configure rules to suit
You will need `libcurl` and `json-c` development libraries installed.

Then run these commands from the checked out folder.

./autogen.sh #build the configure script.
./configure
make
sudo make install.


# Running

Once you have built and installed **syncd**, you will need to create a rules file.

This file should be located in your home folder, and be named `.syncd-rules.json`.
This is a json formatted file specifying where to copy files to/from.

The format of this file is as follows:

{
"plugin:///src/folder/" : [ "plugin:///dest/1/", "plugin:///dest/2/",
"dropbox:///Documents/" : [ "fs:///home/user/Documents/"]
}

The current plugin prifixes are
- `dropbox://` for dropbox
- `fs://` for the filesystem
- `gdrive://` for Google Drive

0 comments on commit f3e1dc7

Please sign in to comment.