Adds prerequisites to README

This commit is contained in:
2025-12-31 00:03:59 +01:00
parent f9001ecb9d
commit 48179034a7

View File

@@ -1,6 +1,19 @@
Unisync is a data synchronisation tool written in python and based on [unison](https://github.com/bcpierce00/unison). 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. 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 # 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. 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.