Metadata-Version: 2.1
Name: hera-py
Version: 0.5.0
Summary: Interpreter for the Haverford Educational RISC Architecture (HERA) assembly language
Home-page: UNKNOWN
Author: Ian Fisher
Author-email: iafisher@protonmail.com
License: MIT
Project-URL: Source, https://github.com/iafisher/hera-py
Description: # hera-py
        
        [![Build Status](https://travis-ci.com/iafisher/hera-py.png)](https://travis-ci.com/iafisher/hera-py)
        [![Coverage Status](https://coveralls.io/repos/github/iafisher/hera-py/badge.svg?branch=master)](https://coveralls.io/github/iafisher/hera-py?branch=master)
        [![PyPI](https://img.shields.io/pypi/v/hera-py.svg?label=version)](https://pypi.org/project/hera-py/)
        
        An interpreter for the [Haverford Educational RISC Architecture](https://www.haverford.edu/computer-science/resources/hera) (HERA) assembly language.
        
        ## Installation
        You can install hera-py with pip:
        
        ```
        $ pip3 install hera-py
        ```
        
        ## Usage
        After installation, use the `hera` command to run a HERA program:
        
        ```
        $ hera main.hera
        ```
        
        Enter the interactive debugger with the `debug` subcommand:
        
        ```
        $ hera debug main.hera
        ```
        
        You can also preprocess a HERA program without running it, to see how pseudo-instructions and labels are resolved to HERA code:
        
        ```
        $ hera preprocess main.hera
        ```
        
        ### Comparison with HERA-C
        HERA-C is the current HERA interpreter used at Haverford. It is implemented as a shell-script wrapper around a set of C++ macros that expand HERA instructions into C++ code, which is then compiled by g++. hera-py aims to improve on HERA-C in the following areas:
          - Ease of use
            - Cross-platform and easy to install
            - Configurable with command-line options
            - Does not create temporary files
            - Can read programs from stdin
            - Command name has six fewer letters than `HERA-C-Run`
          - Helpful error messages
          - Simple debugging
        
        hera-py also supports several features that HERA-C does not:
          - Multi-precision multiplication
          - Relative branching by a fixed integer value (e.g., `BRR(10)`)
          - Branching by the value of a register (e.g., `SET(R1, 20); BR(R1)`)
          - Setting registers to the value of a label
          - Detecting invalid relative branches
        
        HERA-C has a few features that hera-py does not:
          - C-style #define macros (and more generally the ability to embed arbitrary C++ code in HERA programs)
        
        ### Acknowledgements
        Thank you to [Christopher Villalta](https://github.com/csvillalta) for valuable feedback on early iterations of this project.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Topic :: Software Development :: Assemblers
Description-Content-Type: text/markdown
