more READMEs

This commit is contained in:
Axel Kittenberger 2018-03-22 09:23:00 +01:00
parent 7ebfbd91f6
commit 302fb91dc2
4 changed files with 19 additions and 9 deletions

View File

@ -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

5
core/README.md Normal file
View File

@ -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.

View File

@ -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

11
mantle/READE.md Normal file
View File

@ -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.