From 48179034a7f5ea005eaca274a1b7d1126bbdd9d7 Mon Sep 17 00:00:00 2001 From: furtest Date: Wed, 31 Dec 2025 00:03:59 +0100 Subject: [PATCH] Adds prerequisites to README --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 2a2205b..57116c9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,19 @@ Unisync is a data synchronisation tool written in python and based on [unison](https://github.com/bcpierce00/unison). I couldn't find a tool to fulfill the requirements I had for a synchronisation tool so I am creating my own as a wrapper around unison. +# Prerequisite + +You need to have the following tools installed. + +Locally : +- unison +- sshfs +- nnn + +Remotely : +- unison +- cleanlinks and lndir (Should be in `xutils-dev` when using apt) + # Goal Unisync purpose is to keep personal data synchronised between multiple machines without needing to have all the data present an all the machines at the same time. For example you might not need to have your movies on your laptop but still want them on your desktop at home or you might want to keep your old pictures only on a server.