Permalink
Browse files

Fixed some formatting issues

  • Loading branch information...
1 parent 5a5d0ce commit baff32131036943d470d1d1e106162709e500811 @quaec quaec committed Nov 28, 2011
Showing with 11 additions and 11 deletions.
  1. +11 −11 README.rdoc
View
@@ -1,10 +1,10 @@
= lipsync
-A lightweight service that provides automated file synchronization between multiple hosts
+A lightweight service that provides automated file synchronization between multiple hosts.
-lipsync is an open source, lightweight service that provides automated two-way, {Dropbox}[http://bit.ly/1IGiJu]-like file synchronization in Linux by utilizing {OpenSSH}[http://www.openssh.com/], {rsync}[http://rsync.samba.org/], and {lsyncd}[http://code.google.com/p/lsyncd/]. lipsync is a the realization of a popular blog post of mine named {HOWTO build your own open source Dropbox clone}[http://fak3r.com/2009/09/14/howto-build-your-own-open-source-dropbox-clone/] Since I made the posting I've received a great deal of interest, and had time to test and architect a workable solution. Thanks to everyone that read, commented and encouraged the further development of this idea!
+lipsync is an open source, lightweight service that provides automated two-way, {Dropbox}[http://bit.ly/1IGiJu]-like file synchronization in Linux by utilizing {OpenSSH}[http://www.openssh.com/], {rsync}[http://rsync.samba.org/], and {lsyncd}[http://code.google.com/p/lsyncd/]. lipsync is a the realization of a popular blog post of mine named {HOWTO build your own open source Dropbox clone}[http://fak3r.com/2009/09/14/howto-build-your-own-open-source-dropbox-clone/] Since I made the posting I've received a great deal of interest, and had time to test and architect a workable solution. Thanks to everyone that read, commented and encouraged the further development of this idea!
-The basic idea and example of a working system can be seen {here}[https://github.com/philcryer/lipsync/raw/master/docs/diagram.png]
+The basic idea and example of a working system can be seen {here}[https://github.com/philcryer/lipsync/raw/master/docs/diagram.png].
== Features
- automatic file synchronization from multiple clients to a central server
@@ -19,15 +19,15 @@ To get started with lipsync you need at least a client and a server, preferably
- Client - Linux 2.6.x, rsync (client), openssh (client), lsyncd
== Mailing list
-The mailing list for the lipsync project is hosted on Google Groups, signup {here}[https://groups.google.com/group/project-lipsync]
+The mailing list for the lipsync project is hosted on Google Groups, signup {here}[https://groups.google.com/group/project-lipsync].
-== Getting started
- git clone git@github.com:philcryer/lipsync.git
- cd lipsync
- chmod +x install.sh
- ./install.sh
+== Getting started
+ git clone git@github.com:philcryer/lipsync.git
+ cd lipsync
+ chmod +x install.sh
+ ./install.sh
-After that, see the docs/INSTALL file or online, {INSTALL}[https://github.com/philcryer/lipsync/blob/master/docs/INSTALL.rdoc#readme] for full documentation
+After that, see the docs/INSTALL file or online, {INSTALL}[https://github.com/philcryer/lipsync/blob/master/docs/INSTALL.rdoc#readme] for full documentation.
== Caveats
Much of the initial feedback I received asked for a graphical user interface and support for Windows. Please know that I have attempted neither, instead deciding to focus on the basic server-side functionality. This allowed me to flesh out the architecture, deciding on all the options and understanding ways to improve the transfer performance. Since most of the software used for lipsync is cross-platform, I'd be interested in working with others that want to build a gui front end to talk to the the lipsync backend service. I've been interested in the work done on the {SparkleShare}[http://sparkleshare.org/] project, and since it can use different backends I'm hopeful that it will be agnostic enough to adapt to use lipsync.
@@ -51,6 +51,6 @@ You can download this project in either {zip}[http://github.com/philcryer/lipsyn
Or simply clone the project with {Git}[http://git-scm.com/] by running:
- git clone git://github.com/philcryer/lipsync
+ git clone git://github.com/philcryer/lipsync
Thanks

0 comments on commit baff321

Please sign in to comment.