From 302fb91dc2f5d0eb120121e5ccd34a591b9d5c93 Mon Sep 17 00:00:00 2001 From: Axel Kittenberger Date: Thu, 22 Mar 2018 09:23:00 +0100 Subject: [PATCH] more READMEs --- INSTALL | 4 ++-- core/README.md | 5 +++++ core/core.c | 8 +------- mantle/READE.md | 11 +++++++++++ 4 files changed, 19 insertions(+), 9 deletions(-) create mode 100644 core/README.md create mode 100644 mantle/READE.md diff --git a/INSTALL b/INSTALL index a65890e..d0c31ae 100644 --- a/INSTALL +++ b/INSTALL @@ -44,8 +44,8 @@ Building make sudo make install - Building intree: + Building in tree: cmake . make + sudo make install -FIXME make install not yet done diff --git a/core/README.md b/core/README.md new file mode 100644 index 0000000..6f67449 --- /dev/null +++ b/core/README.md @@ -0,0 +1,5 @@ +This is Lsyncd's core. +====================== + +It contains as minimal as possible glues to the operating system needed +for Lsyncd's operation. All high-level logic is coded into the mantle. diff --git a/core/core.c b/core/core.c index b9f27ba..db19ed2 100644 --- a/core/core.c +++ b/core/core.c @@ -1,13 +1,7 @@ /* -| lsyncd.c Live (Mirror) Syncing Demon +| core.c | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | -| This is Lsyncd's core. -| -| It contains as minimal as possible glues to the operating system needed -| for Lsyncd's operation. All high-level logic is coded (when feasable) -| into lsyncd.lua -| | This code assumes you have a 100 character wide display to view it (when tabstop is 4) | | License: GPLv2 (see COPYING) or any later version diff --git a/mantle/READE.md b/mantle/READE.md new file mode 100644 index 0000000..1a94acb --- /dev/null +++ b/mantle/READE.md @@ -0,0 +1,11 @@ +This is the Lsyncd "mantle" +=========================== + +This is where all general operation logic is coded in the Lua language. + +The Lsyncd core written in C handles system glue and is designed to be +as slim as possible. + +The logic for rsync(ssh) handling is written as sync handles provided +by default in the default directory. +