From afad8d73a88a1fcde93dc9b635d5d79fec19cfa7 Mon Sep 17 00:00:00 2001 From: Ivan Olexyn Date: Sat, 18 Jan 2020 12:12:42 +0100 Subject: [PATCH] Update README. --- README.md | 27 +++++++++++++++------------ 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 78089d8..21d6134 100644 --- a/README.md +++ b/README.md @@ -7,29 +7,32 @@
### About -Sync files across directories: -* with rsync -* using config file: sync.conf -* at system start-up (TODO) +Sync files across directories.

### Package Contents -| Class | Description | +| File | Description | |---------------|-------------| -| Execute | Issues com.olexyn.ensync.shell commands.| -| Main | Main class. Run from here.| +| artifacts/SyncDirectory | A directory that is registered to a SyncEntity.| +| artifacts/SyncEntity | A collection of directories that are being syncronized.| +| shell/ | Contains .sh files | +| Execute | Issues sh commands.| +| Main | Run from here.| | Routines | Contains higher level routines.| -| Tools | Simple tools used by other classes.| +| Tools | Contains lower level tools that are used by other classes.|

### Issues -- What about parallel Threads? -- What about error handling? (i.e. if a web-directory is not available) -- Make commands more expressive e.g. collection dir dir dir -> keep all 3 dirs on sync. -- Figure out a way to handle deletions. \ No newline at end of file +- Create a parallel Thread for each SyncEnity. +- Add support for modification dates. + - And thereby eventually support 10 out of 10 file operation types. +- Reduce disk access. +- Have some error handling. (i.e. if a web-directory is not available) +- Create a UI. +- Start the program at system start.