diff --git a/README b/README index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..e491e293f35471c4420486c67fb0aa021d558b52 100644 --- a/README +++ b/README @@ -0,0 +1,52 @@ + + Automata (Algorithms) Library Toolkit + +What is it? +----------- + +The automata (algorithm) library toolkit (ALT) is a mathematical implementation +of various types of automata, grammars, and other common structires along +with mathematical implementation of algorithms over these structures. +Originaly developed on Faculty of Information Technology of Czech Technical +University in Prague. It supposed to be a reference implementation of formal +algorithms as-are in papers, hence allowing practical reuse of existing +algorithms in form of by pipe comunicating tools. + +The Latest Version +------------------ + +Details of the latest version can be found on the project page under +https://gitlab.fit.cvut.cz/travnja3/automata-library. + +Documentation +------------- + +The documentation will be available in each release as HTML format for +data and algo libraries in doc/ directory. + +Installation +------------ + +Project is pure c++ builded by makefile. Minimal version of make is 3.9 +and of g++ is 4.8. Dependencies include binutils-dev libiberty-dev libcppunit-dev libtclap-dev. + +Licensing +--------- + +TODO + +Contacts +-------- + + o If you want to be informed about new code releases, bug fixes, +security fixes, general news and information about the ALT +subscribe to the ?? mailing list as described under ?? + + o If you want freely available support for running ALT please see the +resources at ?? + + o If you have a concrete bug report for ALT please see the instructions +for bug reporting at ?? + + o If you want to participate in actively developing ALT please +subscribe to the `??' mailing list as described at ??