From 9503e0ef1f225d22f55f83bb11bc3b131176e575 Mon Sep 17 00:00:00 2001 From: vanitasvitae Date: Sun, 20 Aug 2017 17:56:38 +0200 Subject: [PATCH] Update README --- README.md | 31 ++++++++++++++++--- .../de/vanitasvitae/sync_client/Slave.java | 2 +- 2 files changed, 28 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ba7eebd..b386748 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,37 @@ # GSoC 2017 - Jingle File Transfer Demo App ## File synchronisation via XMPP. -xmpp_sync has two modes: Master and Slave mode. A client started in master mode will send files -out, while clients in slave mode will receive files. +This application demonstratest the possibilities of Jingle File Transfer via XMPP. xmpp_sync can be used to mirror the contents of one directory across several computers. -In order to use the program, you need at least two XMPP accounts (which might be on different -servers). I recommend using a server, which supports Socks5 proxies. +### Building + +Since some of the code I wrote for Smack is not yet merged, you'll have to build it yourselves. + +``` +git clone git@github.com:vanitasvitae/Smack.git +cd Smack +git checkout jingle3 +gradle install +``` + +Next clone the repository of xmpp_sync. +``` +cd .. +git clone git@github.com:vanitasvitae/xmpp_sync.git +cd xmpp_sync +gradle build +``` + +The resulting executable jar file can be found in `build/libs` afterwards. ### Available options and commands: +xmpp_sync has two modes: Master and Slave mode. A client started in master mode will send files +out, while clients in slave mode will receive files. + +In order to use the program, you need at least two XMPP accounts (which might be on different +servers). I recommend using a server, which supports Socks5 proxies. + The application has the following options available when being started. ``` usage: client [-d] -D [-h] [-m] -p -u diff --git a/src/main/java/de/vanitasvitae/sync_client/Slave.java b/src/main/java/de/vanitasvitae/sync_client/Slave.java index fe9fd47..f78199c 100644 --- a/src/main/java/de/vanitasvitae/sync_client/Slave.java +++ b/src/main/java/de/vanitasvitae/sync_client/Slave.java @@ -49,7 +49,7 @@ public class Slave extends Client { } } } - + target.getParentFile().mkdirs(); offer.accept(connection, target); } catch (InterruptedException | XMPPException.XMPPErrorException | SmackException.NoResponseException | SmackException.NotConnectedException | IOException e) {