README.TXT
July 2017

#    StrEmbed-4 - Embedding assembly structure on to a corresponding hypercube lattice
#    Copyright (C) 2015 - 2017  University of Leeds
#
#    This program is free software: you can redistribute it and/or modify
#    it under the terms of the GNU General Public License as published by
#    the Free Software Foundation, either version 3 of the License, or
#    (at your option) any later version.
#
#    This program is distributed in the hope that it will be useful,
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#    GNU General Public License for more details.
#
#    You should have received a copy of the GNU General Public License
#    along with this program.  If not, see <http://www.gnu.org/licenses/>.

Please read "doc/StrEmbed-4 Users' Manual.pdf" for instructions on
using StrEmbed-4.  Thanks for your interest.

Hau Hing Chau
H.H.Chau@leeds.ac.uk

School of Mechanical Engineering
University of Leeds
Leeds
LS2 9JT
United Kingdom

--- * --- * ---

Files
=====

README.txt                              This README.txt file
bin/gpl.txt                             Full text of GNU General Public License version 3
bin/StrEmbed-4.pl                       Main perl script of StrEmbed-4
bin/StrEmbed/StrEmbed_4_step.pm         Perl module for parsing STEP AP214 files
bin/StrEmbed/StrEmbed_4_hypercube.pm    Perl module for generating hypercubes
bin/StrEmbed/StrEmbed_4_gui.pm          Perl module for GUI
bin/StrEmbed/StrEmbed_4_tree_editor.pm  Perl module for assembly tree editor
bin/StrEmbed/FileSelect.pm              Customised perl module FileSelect.pm for GUI for
                                        opening and saving files.  Based on original
                                        FileSelect by Klaus Lichtenwalder and maintained
                                        by Slaven Rezić (version 4.018) on CPAN.
bin/resources/                          Sub-directory for icons and other resources
solidworks_data/                        Sub-directory for source SolidWorks assemblies
                                        and part files
step_data/input/                        Sub-directory for STEP AP214 files for the use
                                        of StrEmbed-4
step_data/output/                       Sub-directory for storing output STEP AP214
                                        files from StrEmbed-4
doc/                                    Sub-directory for documentation
doc/StrEmbed-4 Users' Manual.pdf        StrEmbed-4 Users' Manual