furtest/unisync
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs : add explanation of what is unisync

Browse Source 
also add an example
This commit is contained in:
furtest
2026-01-20 23:39:48 +01:00
parent e639c12c20
commit 7705731dd5
2 changed files with 39 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/source/index.rst
View File

@@ -6,13 +6,26 @@
Documentation for unisync
=========================
Unisync is a data synchronising tool built around `unison`_
Unisync is a data synchronising tool built around `unison`_ and expending on it.
Unisync tries to solve two problems that are often solved separately but never together :
* Keeping your data synchronised between multiple machines (through a central server), examples of this are rsync and of course unison.
* Being able to access and edit files stored on your server without having to download them, the gui interface of nextcloud for example.
* And of course I want to be able to do all of this without ever having to leave my terminal.
Unisync solves this problem by placing each file on your local machine but with only the selected files and folders being physically present on your drive,
the others are replaced by symbolic links pointing to a directory that is mounted from your server.
See this
:ref:`example_how_it_works`.
.. _unison: https://github.com/bcpierce00/unison
.. toctree::
:maxdepth: 2
:caption: Contents:
example
modules