README

Archiving hint: In late summer 2023, Github started to enforce 2FA (Two Factor
                Authentication), so I had to archive it before losing control
                over it.  See also https://github.com/Traumflug/simulavr/issues/14

                Traumflug, August 2023

Forking hint: Purpose of this fork is to add a number of features required for
              Teacup Firmware https://github.com/Traumflug/Teacup_Firmware
              These features weren't accepted upstream, so this reopitory has
              to stay for that purpose.  Simulating Teacup works just great
              and insights gained by doing so brought a lot of performance
              and quality improvements.  Awesome!


#
#  $Id$
#

     *** Welcome to simulavr ***

For installing this package please read INSTALL. 

If you find bugs, have interesting new features or questions please write
an EMail to: <simulavr-devel@nongnu.org>

If you want start contributing the package, please let us know what you
plan to do. Actually the project is mostly stable at all sources but
some changes or bugfixes can come without any notice. If you start an action
please let us know so that a patch could be applied before it is nearly
impossible :-)

Supported Plattforms:
Linux/i386: yes
Linux/others: ??? (if you run a system with this plattform please let
    us know)
Max OSX: Sorry, not yet. We need a tester to make the build toolchain
    running. There should be no technical problems but we have no
    test system for this. Thanks!
Win/Mingw: yes (but TCL interface isn't checked or build)
others: ??? (if you run a system with this plattform please let us know)

Building From CVS
=================
./bootstrap
./configure
make
make check

NOTE: If you are modifying Makefile.am and configure.ac files, you
      need to configure with --enable-maintainer-mode.

Examples
========
Look in the examples subdirectory for a variety of examples

Documentation
=============
A manual is in doc.  Please contribute to improving it.