Skip to content

Commit

Permalink
Cleanup code and update dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
cyderize committed Mar 24, 2024
1 parent 21b1b57 commit d3059a4
Show file tree
Hide file tree
Showing 91 changed files with 4,334 additions and 51,042 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build-and-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
- name: Checkout Repo
uses: actions/checkout@master
- name: Install Dependencies
run: npm install
run: npm ci
- name: Build
run: npm run build
- name: Push to gh-pages
Expand Down
6 changes: 2 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,9 @@ Temporary Items

# Node modules and build folder
node_modules
/build
build/index.html
build/about.html
build
working

doc

# Vim
*.swp
27 changes: 2 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# MARIE.js

[![Build Status](https://travis-ci.org/MARIE-js/MARIE.js.svg?branch=master)](https://travis-ci.org/MARIE-js/MARIE.js) [![Gitter chat](https://badges.gitter.im/MARIE-js/gitter.png)](https://gitter.im/MARIE-js/Lobby) [![npm version](https://badge.fury.io/js/npm.svg)](https://badge.fury.io/js/npm)
==============
Current version: `1.3.0`

MARIE.js is an implementation of a simulator for a 'Machine Architecture that is Really Intuitive and Easy'
from [The Essentials of Computer Organization and Architecture](https://books.google.com.au/books/about/The_Essentials_of_Computer_Organization.html?id=3kQoAwAAQBAJ&redir_esc=y) (Linda Null, Julia Lobur) in JavaScript.
Expand Down Expand Up @@ -36,34 +33,14 @@ well as opening the default browser directing to the localhost site.
To test and build the development version of MARIE.js, run the following
commands.

npm ci
npm run start

# or if you are using yarn

yarn start

## Building
To build just run

npm run build

# or if you are using yarn

yarn build


### Electron Mode
cd /path/to/repo/MARIE.js
npm install
npm install grunt-cli
npm install electron //for electron branch
grunt test # you need JRE 8 for this command
grunt bar-dev


## To Do List
To view full to-do list visit: [https://github.com/MARIE-js/MARIE.js/issues/162](https://github.com/MARIE-js/MARIE.js/issues/162)

## Documentation
We use jsdoc for documenting the code. This can be found within the `doc`
folder.
Expand Down Expand Up @@ -101,7 +78,7 @@ accepted, we'll add your name to our license.
### The MIT License (MIT)

Copyright © 2016 - 2019 Jason Nguyen, Saurabh Joshi, Eric Jiang, Erfan Norozi, Josh Nelsson-Smith, Guido Tack
Copyright © 2017 - 2019 Monash University
Copyright © 2017 - 2024 Monash University

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

Expand Down
5 changes: 2 additions & 3 deletions build/about.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

<!DOCTYPE html>
<html>
<head>
Expand Down Expand Up @@ -90,7 +89,7 @@

<main>
<div id="about" class="container">
<h1 class="center">MARIE.js <span class="version">v1.3.0</span></h1>
<h1 class="center">MARIE.js <span class="version">v1.4.0</span></h1>
<h2>About MARIE</h2>
<p>MARIE ('Machine Architecture that is Really Intuitive and Easy') is a machine architecture and assembly language from <a href="https://books.google.com.au/books/about/The_Essentials_of_Computer_Organization.html?id=3kQoAwAAQBAJ&redir_esc=y" target="_blank">The Essentials of Computer Organization and Architecture</a> (Linda Null, Julia Lobur). The publisher provides a set of <a href="http://computerscience.jbpub.com/ecoa/3e/simulators.aspx">simulators for the machine</a>, written in Java. However, since using simulators can be rather difficult, we have implemented a web-based version, so that students are able to access it readily and easily. Since beginning the project we have added many features such as importing and exporting of Marie Assembly Source files (*.mas) to provide compatibility with the existing simulators.</p>
<br>
Expand Down Expand Up @@ -133,7 +132,7 @@ <h2>License</h2>
<h4 class="modal-title"> MARIE.js | <i class="fa fa-hashtag"></i> Current Version</h4>
</div>
<div class="modal-body">
<p>This version of <strong>MARIE.js</strong> is: v1.3.0</p>
<p>This version of <strong>MARIE.js</strong> is: v1.4.0</p>
</div>
</div>
</div>
Expand Down
16 changes: 11 additions & 5 deletions build/index.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

<!DOCTYPE html>
<html>
<head>
Expand Down Expand Up @@ -208,8 +207,9 @@
<ul class="nav nav-tabs">
<li class="active"><a data-toggle="tab" href="#output-log-outer">Output log</a></li>
<li><a data-toggle="tab" href="#register-log-outer">RTL log</a></li>
<li><a data-toggle="tab" href="#watch-list-outer">Watch list</a></li>
<li><a data-toggle="tab" href="#input-list-outer">Input list</a></li>
<li><a data-toggle="tab" href="#watch-list-outer">Watches</a></li>
<li><a data-toggle="tab" href="#input-list-outer">Inputs</a></li>
<li><a data-toggle="tab" href="#display-outer">Display</a></li>
</ul>
<div class="tab-content">
<div id="output-log-outer" class="tab-pane in active">
Expand Down Expand Up @@ -251,14 +251,20 @@
<hr>
<textarea id="input-list"></textarea>
</div>
<div id="display-outer" class="tab-pane">
<div id="dma-display-memory-container">
<span>16x16 display, 0xF00-0xFFF:</span>
<table id="dma-display-memory"></table>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="status-info-container" class="row light-grey">
<div id="status-info">MARIE.js</div>
</div>
<div class="row" style="align:text-center">
<div class="row" style="text-align:center">
<div id="memory-display" data-toggle="tooltip" data-placement="right" title="Green: Current PC; Yellow: Current MAR" >
<table id="memory-headers"></table>
<div id="memory-container">
Expand Down Expand Up @@ -337,7 +343,7 @@ <h4>Input Value</h4>
<h4 class="modal-title">MARIE.js | <i class="fa fa-hashtag"></i> Current Version</h4>
</div>
<div class="modal-body">
<p>This version of <strong>MARIE.js</strong> is: v1.3.0</p>
<p>This version of <strong>MARIE.js</strong> is: v1.4.0</p>
</div>
</div>
</div>
Expand Down
1 change: 0 additions & 1 deletion dist/CNAME

This file was deleted.

134 changes: 0 additions & 134 deletions dist/about.html

This file was deleted.

Binary file removed dist/book.pdf
Binary file not shown.
15 changes: 0 additions & 15 deletions dist/code/addition.mas

This file was deleted.

32 changes: 0 additions & 32 deletions dist/code/multiply.mas

This file was deleted.

Loading

0 comments on commit d3059a4

Please sign in to comment.