Repository files navigation

Current version:1.0.0-preview

MARIE.js is an implementation of a simulator for a 'Machine Architecture that is Really Intuitive and Easy'fromThe Essentials of Computer Organization and Architecture (Linda Null, Julia Lobur) in JavaScript.

Try the simulator

Latest Stable:https://github.com/MARIE-js/MARIE.js/releases/latest

Latest Release:https://github.com/MARIE-js/MARIE.js/archive/master.zip

This is for web developers who would like to develop, build or deploy theMARIE.js project. If this is you, then continue reading below.

MARIE.js is essentially a front-end only site with no servers or databases.The tools we use arenpm andgrunt, which makes developing this projecta little easier.

It is recommended that you use a Unix-like operating system to build, test andrun the code. You'll need to installnpm, then run the following commands toinstall dependencies, build the release version, and run a localhost server aswell as opening the default browser directing to the localhost site.

sudo npm install -g grunt-clicd /path/to/repo/MARIE.jsnpm installgrunt

To test and build the development version of MARIE.js, run the followingcommands.

cd /path/to/repo/MARIE.jsnpm installgrunt test # you need JRE 8 for this commandgrunt bar-dev

To view full to-do list visit:#162

We use jsdoc for documenting the code. This can be found within thedocfolder.

If you want to build the documentation website again (if you have, say, madesome changes to the documentation of the JavaScript code), then run thiscommand.

grunt jsdoc

If you would like to contribute to this project, simply fork this repositorythen make the changes to the forked repository. Once changes are made, perform apull request to this repository. We'll review the pull request, and if it isaccepted, we'll add your name to our license.

[D] Dependency Update[HF] HotFix[P] Patch[UI] User Input (including css) Update[O] Other

Copyright © 2016 Jason Nguyen, Saurabh Joshi, Eric Jiang, Erfan Norozi

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:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.