Add preliminary members base documentation.

This commit is contained in:
Dominik Pantůček 2023-03-24 22:14:59 +01:00
parent dd1ab494af
commit f295cd4802

32
MEMBERS.md Normal file
View file

@ -0,0 +1,32 @@
Members Base
============
This file documents the internal structure of the members information
storage.
Members Directory
-----------------
Files in this directory with file names being four decimal digits are
member files. The file name is the member id.
Symlinks to the member files serve as human-readable aliases.
The implementation handles situation when the human-readable name is
the member file and the symlink is the four-digit member id.
Member File Preprocessing
-------------------------
Member files are read line-by-line.
Comments start with the ```#``` character and continue until the end
of particular line.
Comments are stripped from each line before parsing.
Member File Grammar
-------------------
Member File Schema
------------------