Metadata-Version: 2.1
Name: STARSimulator
Version: 1.0.6
Summary: STARS (Stony Brook Assembler and Run-time Simulator) is a MIPS Assembly simulator made for the purpose of education.
Home-page: https://github.com/sbustars/STARS
Author: STARS
Author-email: jason.osoriomarin@cs.stonybrook.edu
Project-URL: Bug Tracker, https://github.com/sbustars/STARS/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy (>=1.5)
Requires-Dist: pyside6 (>=6.4.2)

# The STARS Code Repository

## Overview
This repository hosts the public releases of STARS (Stony Brook Assembler and Run-time Simulator). STARS is a MIPS Assembly simulator made for the purpose of education.

## Dependencies
* PySide6 (v6.4 or newer)
* numpy (v1.23 or newer for Windows)

# How to run:
Install the package.
```
$ pip install STARSimulator
```

Finally, run the program.
```
$ STARS [-h] [-a] [-d] [-g] [-n MAX_INSTRUCTIONS] [--noGui] [-i] [-w] [-pa PA [PA ...]] [filename]
```

##### Positional arguments:
* `filename`       Input MIPS Assembly file.

##### Optional arguments:
* `-a`, `--assemble`    Assemble program without running it
* `-h`, `--help`     Shows help message and exits
* `-a`, `--assemble`    Assemble program without running it
* `-d`, `--debug`    Enables debugging mode
* `-g`, `--garbage`  Enables garbage data
* `-n`, `--max_instructions`  Sets max number of instructions
* `--noGui` no GUI, CLI only
* `-i`, `--disp_instr_count`  Displays the total instruction count
* `-w`, `--warnings`  Enables warnings
* `-pa`  Program arguments for the MIPS program


# Troubleshooting
* If you are on Mac (especially Big Sur) and the gui mainwindow doesn't lauch, run `export QT_MAC_WANTS_LAYER=1` in the terminal.
