Add README skeleton.

This commit is contained in:
Dominik Pantůček 2023-03-20 19:39:40 +01:00
parent 8bb12c6e68
commit bf7788d366

66
README.md Normal file
View file

@ -0,0 +1,66 @@
BrmBuro
=======
Brmlab Bureacratic system.
License
-------
ISC License
Copyright 2023 Brmlab, z.s.
Dominik Pantůček <dominik.pantucek@trustica.cz>
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
---------------