https://github.com/donn/oak.js

Online RISC-V/MIPS Assembler & Simulator
https://github.com/donn/oak.js

instruction-set-simulator iss risc-v riscv

Last synced: 24 days ago
JSON representation

Online RISC-V/MIPS Assembler & Simulator

• Host: GitHub
• URL: https://github.com/donn/oak.js
• Owner: donn
• License: mpl-2.0
• Created: 2016-11-13T13:25:14.000Z (about 8 years ago)
• Default Branch: main
• Last Pushed: 2022-07-18T11:36:26.000Z (over 2 years ago)
• Last Synced: 2024-04-24T11:16:13.120Z (8 months ago)
• Topics: instruction-set-simulator, iss, risc-v, riscv
• Language: JavaScript
• Homepage: https://oak.js.org
• Size: 2.41 MB
• Stars: 10
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Oak.js](public/images/logo.png)

An assembler and simulator generator written in ~~TypeScript~~ JavaScript.

It supports both RISCV (RV32I) and MIPS (Core Instruction Set).

The assembler and simulator were designed by [@donn](https://github.com/donn) and the user interface for the web version was designed by [@KarimIO](https://github.com/KarimIO).

Special thanks to [@alikhaled96](https://github.com/alikhaled96) for helping implement MIPS.

# Requirements and Building

Node v12 or higher.

If you just want to use Oak.js, it should work fine on any modern browser, bar modern versions of Internet Explorer.

## Getting Node

### Unix

Use `tj/n` to install node.

    

    curl -L https://git.io/n-install | bash

    sudo n lts

    

### Windows

Please use WSL2 for Windows 10 and follow the instructions for Debian-based OSes for a supported and tested workflow.

If you do not wish to use the Linux subsystem, try first installing Node.js from [their website](http://nodejs.org/). This codebase uses symlinks, however, so no promises this will function.

Like Debian-based OSes, you may need administrative privileges for this.

## Getting yarn

Type `npm i -g yarn`. Simple.

## Installing Dependencies

You also need to install package dependencies. You can just write `yarn install`.

# Usage

For the web, `yarn start` for the CLI, invoke `node ./main.js --help`.

# License

Mozilla Public License 2.0. Check LICENSE.