From 85982c9aa11a86eb2b18bb2d9527fa79917ee95c Mon Sep 17 00:00:00 2001 From: Hykilpikonna Date: Thu, 10 Nov 2022 14:45:39 -0500 Subject: [PATCH] [U] Update readme --- README.md | 29 ++++++++++------------------- 1 file changed, 10 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index e092c42..98e5d5c 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,19 @@ -## MARS Assembler -[MARS][1] is a lightweight interactive development environment (IDE) for programming in MIPS assembly language, intended for educational-level use with Patterson and Hennessy's Computer Organization and Design. +## E-MARS: Enhanced MARS Assembler -MARS has been jointly developed by [Pete Sanderson][4] (programming) and [Ken Vollmar][5] (details and paperwork). +[MARS][1] is a lightweight interactive development environment (IDE) for programming in MIPS assembly language, developed by [Pete Sanderson][4] (programming) and [Ken Vollmar][5], intended for educational-level use with Patterson and Hennessy's Computer Organization and Design. -## Download -You can download the latest version [at the official website][6]. +**EMARS** (this repo) is Azalea's enhanced version of MARS. -## Purpose of this repo -This repo is a mirror of the source code of MARS Assembler. Though the source code is into the "MARS.jar" file at the download page, this is a mirror for people who wants to have the source code forked or that stuff. +## Changes from Mars 1.4: -I'm not going to accept any pull request. This source code is not maintained by me but the original developers. If you want to contribute to the project, you should talk with them [going here][8]. +### EMARS 1.5 -## Documentation (included in the repo) - - Go to the [documentation][7]. - - In order to run or compile MARS v4.XX, **MARS requires Java J2SE 1.5 (or later) SDK installed on your computer**. +* Switched to Gradle build system with Kotlin support -## How to run MARS - - **Option A**: Desktop. Save the jar file on the desktop. Run MARS by double-clicking the icon. - - **Option B**: DOS shell using jar file. Save the jar file in some folder. Open a DOS shell in that folder. Rename the jar file to "Mars.jar" for convenience. Run MARS with the DOS command java -jar Mars.jar - - **Option C**: DOS shell using Java classes. Save the jar file in some folder. Open a DOS shell in that folder. Rename the jar file to "Mars.jar" for convenience. Extract MARS files with the DOS command jar -xf Mars.jar Run MARS with the DOS command java Mars +## FAQ -## How to compile - - **Windows**: execute "CreateMarsJar.bat" file to generate an executable. - - **GNU/Linux** and **Mac**: execute the "CreateMarsJar.sh" to generate an executable. If you can't due of permissions, do a "**chmod +x CreateMarsJar.sh**" (Thanks to [@aesptux][8] to be the tester in Mac). +**How to run:** Install Java JDK >11 and double-click on the jar. +**How to compile:** `gradle build` ## License [MIT][2]. Chech the [LICENSE][3] file. All the credits go to the original developers. @@ -34,4 +25,4 @@ I'm not going to accept any pull request. This source code is not maintained by [5]: http://courses.missouristate.edu/KenVollmar/ [6]: http://courses.missouristate.edu/KenVollmar/MARS/download.htm [7]: http://courses.missouristate.edu/KenVollmar/MARS/Help/MarsHelpIntro.html - [8]: http://twitter.com/aesptux \ No newline at end of file + [8]: http://twitter.com/aesptux