diff --git a/README.md b/README.md index 5741cdf0f..fe0bab9e0 100644 --- a/README.md +++ b/README.md @@ -316,7 +316,7 @@ The folder [`3rdparty/`](3rdparty) contains 3rd party applications licensed unde ## Contacts -See [AUTHORS.md](AUTHORS.md) +See [AUTHORS.md](AUTHORS.md). ## Acknowledgements @@ -327,3 +327,7 @@ We thank for the support received from the Brno University of Technology This tool as well as the information provided on this web page reflects only the author's view and no organization is responsible for any use that may be made of the information it contains. + +## Branches + +See [docs/src/branches.md](docs/src/branches.md). diff --git a/bindings/python/Makefile b/bindings/python/Makefile index a395f9dcf..0545233d8 100644 --- a/bindings/python/Makefile +++ b/bindings/python/Makefile @@ -26,14 +26,11 @@ pypi-release: python setup.py sdist clean: - find . -type d -name "__pycache__" -exec rm -rf {} + + find . -type d \( -name "__pycache__" -o -name "*.egg-info" \) -exec rm -rf {} + find . -type f \( -name "*.cpp" -o -name "*.dot" -o -name "*.so" -o -name "*.pdf" \) -exec rm -f {} + rm -rf \ .coverage \ dist/ \ - libmata.egg-info/ \ - mata_py.egg-info/ \ - libmata.cpp \ MANIFEST \ virtenv diff --git a/docs/src/branches.md b/docs/src/branches.md new file mode 100644 index 000000000..59ead783a --- /dev/null +++ b/docs/src/branches.md @@ -0,0 +1,47 @@ +# Branches + +Notable branches in Mata. + +## Main branches + +### [`master`](https://github.com/VeriFIT/mata/tree/master) + +The production release branch of Mata. + +### [`devel`](https://github.com/VeriFIT/mata/tree/devel) + +The developement branch of Mata, providing development releases, used to quickly iterate on new features in Mata without +breaking the userland during development. +`devel` is always kept in-sync with `master`. + +## Backups + +Backed-up branches with experiments. + +### [`simulation-samo538.bak`](https://github.com/VeriFIT/mata/tree/simulation-samo538.bak) + +- Author: [Samuel Lupták (samo538)](https://github.com/samo538) +- As part of: [Project Practice 1, BIT](https://www.fit.vut.cz/study/course/IP1/.en) +- From: + +Backup of a NFA reduction algorithm using maximum direct simulation. +Pseudo-algorithm is taken from . +The experimental results show the algorithm is not outperforming the already existing RT algorithm for simulations. + +### [`simulation-reduction-rules-samo538.bak`](https://github.com/VeriFIT/mata/tree/simulation-reduction-rules-samo538.bak) + +- Author: [Samuel Lupták (samo538)](https://github.com/samo538) +- As part of: [Project Practice 2, BIT](https://www.fit.vut.cz/study/course/IP2/.en) +- From: + +Backup of a NFA reduction algorithm enhancement using maximum direct simulation with support for reduction rules. + +### [`boost-determinization-inclusion-lacko.bak`](https://github.com/VeriFIT/mata/tree/boost-determinization-inclusion-lacko.bak) + +- Author: [Igor Lacko (Igor-Lacko)](https://github.com/Igor-Lacko) +- As part of: [Project Practice 1, BIT](https://www.fit.vut.cz/study/course/IP1/.en) +- From: + +Backup of a variant of determinization and inclusion algorithms using the Boost data structures (bit vectors). +Requires Boost as an external dependency. +The Boost implmentation of bit vectors can be replaced with a manual implementation of diff --git a/docs/src/introduction.rst b/docs/src/introduction.rst index d8ff23b72..1b1e39949 100644 --- a/docs/src/introduction.rst +++ b/docs/src/introduction.rst @@ -3,3 +3,6 @@ Introduction .. include :: ../../README.md :parser: myst_parser.sphinx_ + +.. include :: ./branches.md + :parser: myst_parser.sphinx_