#############################################################################
##
##  README              ToricVarieties package
##                      Martin Bies -- University of Oxford
##                      Sebastian Gutsche
##
##  Copyright 2020
##
##  A package to compute properties of toric varieties
##
#############################################################################

README file for the `ToricVarieties' GAP4 package


(1) Installation
--------------------------

To get the latest version of this GAP 4 package, clone ToricVarieties_project from github (https://github.com/homalg-project/ToricVarieties_project). This completes the installation process.


(2) Documentation and test
--------------------------

You can create the documentation for this package by issuing

make doc

inside the ToricVarieties/doc folder. If a running LaTeX installation is available, the documentation will subsequently be available as manual.pdf.

If you later want to delete the existing documentation and create it anew (e.g. after updating to a new version of this package), issue the following

make docclean
make doc

You can test the installation by issuing

make test


(3) Contact
--------------------------

E-mail me if there are any questions, remarks, suggestions. Also, I would like to hear about applications of this package.

Martin Bies, martin.bies@alumni.uni-heidelberg.de


(4) Funding
--------------------------

The work of Martin Bies is supported by the Wiener-Anspach Foundation.
