SATK - Stand-alone Tool Kit

Copyright (C) 2012-2016, 2020 Harold Grovesteen                     

SATK is intended to assist in the development of stand-alone, or baremetal,
programs on mainframe compatible systems.  While targeting the Hercules
emulator, nothing precludes its use with "big-iron" real or virtual
environments.

Getting Started:
    Use the "Download ZIP" button on this page to download the current
    repository contents.  By "unzipping" the downloaded file into your file
    system, the package is installed on your system.  (By deleting the SATK
    directory and its contents the package is uninstalled.)

    Then follow the directions in the file SATK/doc/asma/ASMA.pdf,
    "Getting Started" section, for additional steps required to prepare
    your system for use of A Small Mainframe Assembler and other SATK
    tools.

The following directories are provided:
    asma            - A Small Mainframe Assembler (ASMA) for stand-alone
                      programs.  ASMA runs wherever Python 3.3 runs!
    doc             - Various related documentation.
    doc/asma        - ASMA related documentation
    doc/iplelf      - Documentation related to the IPL ELF Supplement and SATK 
                      support.
    lib             - GNU ld linker scripts
    samples         - Various IPL related samples
    samples/asma    - Sample programs using ASMA
    src             - source code for use in stand-alone programs.
    src/drivers     - Device drivers - very experimental, do not recommend use
    src/hal         - Hardware Abstraction Layer
    src/ipl         - IPL ELF supporting source
    src/ipl/include - Routines useful for IPL ELF stage0 loaders.
    src/storage     - Storage management functions.  Only static assignment 
                      supported.
    srcasm          - Bare-metal facilities using ASMA.
    tools           - Python and bash tools for use with SATK.
                         asma.py - command-line interface to ASMA
                         codepage.py - ASMA code page customization
                         config.py - local tool configuration management and testing
                         deck.py - Card deck and AWS tape merge / creation tool
                         fp.py - floating point utility
                         hopcodes.py - Hercules instruction audit tool
                         msl.py - Machine Specification Language (MSL) processor
                         mslrpt.py - MSL architecture comparison report
                         xmi.py - XMI file format PDS and member utility
    tools/herc      - Hercules emulator specific tools
    tools/ipl       - IPL ELF Media Preparation Processor, iplmed.py, and 
                      related tools: ipldpp.py, media.py
    xforth          - Forth language cross-compiler framework

This file is part of SATK.

SATK 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.

SATK 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 SATK.  If not, see <http://www.gnu.org/licenses/>.


LICENSING
---------

Unless otherwise indicated SATK is licensed under the GNU General Public License
version 3 or later.  The license can be found in the file COPYING in the
project root directory.  Documentation is licensed under the GNU Free 
Documentation License version 1.3 and can be found in the file fdl-1.3.txt 
in the doc directory.

The directory xforth is licensed under the Simplified BSD License containing
modifications to a package using this licensing.  The Simplified BSD License
can be found in the file LICENSE.txt in the xforth directory.  The file 
forth_words.py in the xforth directory contains public domain software.  See
the xforth file forth.py for details of the original package on which this
directory is based.


REQUIREMENTS
------------
Python 3.3 or higher            www.python.org


Contact the author, Harold Grovesteen, at 
  - satk@groups.io or 
  - groups@hercules-390.groups.io