Skip to content
This repository has been archived by the owner on Sep 29, 2023. It is now read-only.

A Visual Studio Code extension for Nand2Tetris development based on Zohar Lee's "Nand2Tetris Tools".

License

Notifications You must be signed in to change notification settings

foxyseta/mastro-nando

 
 

Repository files navigation

Mastro NANDo

Mastro NANDo Logo

Visual Studio Marketplace Installs Visual Studio Marketplace Downloads

Introduction

Mastro NANDo is a Visual Studio Code extension for Nand2Tetris development based on Zohar Lee's "Nand2Tetris Tools". It empowers an incorporated release of the Nand to Tetris Software Suite with various Visual Studio Code functionalities. This extension is meant for students, instructors, and self-learners who want to enhance their Nand2Tetris experience.

Features

Commands

Name Icon Requires Nand to Tetris Software Suite Description
Run code Run Code button ✔︎ Runs your current file (supports .hdl, .asm, hack and .vm files) via CLI. Needs a .tst file in the same folder to work.
Stop running ✔︎ Aborts code execution
Translate code Translate Code button ✔︎ Translate your current file (supports .asm and jack files) via CLI
Open Hardware Simulator ✔︎ Runs the Hardware Simulator via GUI
Open CPU Emulator ✔︎ Runs the CPU Simulator via GUI
Open VM Emulator ✔︎ Runs the VM Emulator via GUI
Assembler ✔︎ Runs the Assembler via GUI
Compile directory ✔︎ Compiles the directory of your current file (supports .jack files)
Zip course source Compresses your solution to a zip archive

Languages and icon theme

Language File Extensions Grammar Snippets Icon
Hardware Description Language .hdl ✔︎ ✔︎ ✔︎
Test scripts format .tst ✔︎ ✔︎ ✔︎
Compare and output files format .cmp, .out ✔︎ ✔︎
Hack Assembly .asm ✔︎ ✔︎
Hack Machine Language .hack ✔︎ ✔︎
Hack Virtual Machine Language .vm ✔︎ ✔︎ ✔︎
Jack Language .jack ✔︎ ✔︎ ✔︎

Any icons not listed in the table above have been included in the extension from VS Code's built-in icon theme Seti.

User setup

Prerequisites

  1. Visual Studio Code

  2. Java Runtime Environment (recommended, but needed only if you want to use functionalities related to the Nand to Tetris Software Suite)

There is no need to manually install the Nand to Tetris Software Suite, as it is already incorporated in the extension itself.

Installation

Please launch VS Code Quick Open (Ctrl + P), digit ext install foxyseta.mastro-nando, and press enter. You may also visit the Visual Studio Code Marketplace for further support.

Contributor setup

After cloning this GitHub repository, you might want to follow through with the documentation relating VS Code's Extension API.