From bf7788d366900aa29ab8ea3e5e1f2de3efe9b7d9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dominik=20Pant=C5=AF=C4=8Dek?= Date: Mon, 20 Mar 2023 19:39:40 +0100 Subject: [PATCH] Add README skeleton. --- README.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..3e6f6ac --- /dev/null +++ b/README.md @@ -0,0 +1,66 @@ + +BrmBuro +======= + +Brmlab Bureacratic system. + +License +------- + +ISC License + +Copyright 2023 Brmlab, z.s. +Dominik Pantůček + +Permission to use, copy, modify, and/or distribute this software +for any purpose with or without fee is hereby granted, provided +that the above copyright notice and this permission notice appear +in all copies. + +THE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL +WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE +AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR +CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS +OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, +NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN +CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + +Features +-------- + +* members base management + * member files parsing and validation + * member ids validation + * generating new member id + * per-month statistics of active, suspended, destroyed and student + members + * detailed member information + * querying members by id or nick + +Requirements +------------ + +There are no runtime requirements, it is possible to build binary that +requires only libc. + +Build requirements: + +* Chicken Scheme 5 +* make (tested with GNU make) + +It is possible to run the main tool as script with Chicken Scheme +interpreter and POSIX-compatible shell for the purpose of development. + +Development requirements: + +* POSIX shell + +Functional Modules +------------------ + +Support Modules +--------------- + + +