chore: improve Dockerfile, add CONTRIBUTING, sort package.json

CONTRIBUTING.md

@@ -0,0 +1,5 @@
+# Contributing to SIMDE
+
+Thank you for your interest in contributing to SIMDE! What follows is a list of possible actions to contribute to this project:
+
+* Report any bug you encounter by [filing an issue]().

README.md

@@ -1,43 +1,48 @@
 # SIMDE
-[![Build Status](https://travis-ci.org/etsiiull/SIMDE.svg?branch=master)](https://travis-ci.org/etsiiull/SIMDE)
-[![All Contributors](https://img.shields.io/github/all-contributors/SIMDE-ULL/SIMDE?color=ee8449&style=flat-square)](#contributors)
+<p align="center">
+    <img alt="SIMDE Build Status" src="https://img.shields.io/github/actions/workflow/status/SIMDE-ULL/SIMDE/build.yml" />
+    <img alt="SIMDE License" src="https://img.shields.io/github/license/SIMDE-ULL/SIMDE" />
+    <img alt="SIMDE Stars" src="https://img.shields.io/github/stars/SIMDE-ULL/SIMDE" />
+    <img alt="SIMDE Contributors" src="https://img.shields.io/github/all-contributors/SIMDE-ULL/SIMDE?color=ee8449&style=flat-square" />
+</p>
 
-![Live exec](/assets/exec.gif)
-
-## What is SIMDE?
-
-SIMDE is a simulator for supporting teaching of [ILP (Instruction Level Parallelism)](https://en.wikipedia.org/wiki/Instruction-level_parallelism) Architectures. 
-
-This simulator is a visual representation of a Superecalar machine execution and the students are able to see how the instructions move through the multiple stages of the pipeline. 
+<p align="center">
+    <img width="480px" height="416px" alt="SIMDE Logo" src="https://github.com/SIMDE-ULL/SIMDE/assets/25517190/6af8eb99-8b46-4f08-a78a-195863fff035" />
+</p>
 
-This make easier to learn concepts suchs as *Tomasulo's algorithm* and the purpose of structures such as the reorderbuffer.
+> Access SIMDE from your browser here: https://SIMDE-ULL.github.io/SIMDE/
 
-## Technologies
+SIMDE is a [computer](https://en.wikipedia.org/wiki/Computer_architecture) simulator. Its main focus is the teaching of [ILP (Instruction Level Parallelism)](https://en.wikipedia.org/wiki/Instruction-level_parallelism) concepts.
 
-SIMDE is powered by Typescript, React, Redux, Sass and Webpack.
+Superscalar mode the visualization how the instructions flow through the multiple stages of the instruction pipeline. 
 
-## How to use
+When used as an assist tool, SIMDE supercharges learning concepts suchs as *Tomasulo's algorithm* and the purpose of structures such as the Reorder Buffer.
 
-[Go to the project website and start learning](https://etsiiull.github.io/SIMDE/)
-
-## Development
-
-SIMDE is build on top of typescript,sass and webpack. In order to make the build easier a docker file environment has been added.
-Just install docker and docker-compose and type:
+## SIMDE in action
+![Live exec](/assets/exec.gif)
 
-`docker-compose up`
+## Features
+* ILP
+* Simple, Easy to use
+* Cross-platform and web based
+* Superscalar
+* VLIW
+* Batch execution
+* Taint analysis
+* Deterministic
+* 
 
-All services should be configurated and ready for deployment.
 
-Please beware that we copy the package.json each time we build the image so if you add more dependencies you should run `docker-compose build` in order to recreate the image.
+## Getting started
 
-## Troubling?
+[Go to the project website and start learning](https://SIMDE-ULL.github.io/SIMDE/)
 
-If you have any doubt you should check [the official docs](https://etsiiull.gitbooks.io/simde/).
+## Contributing
+See [CONTRIBUTING](CONTRIBUTING.md).
 
 ## License
 
-The project has been released under GPLv3 License.
+SIMDE is licensed under the [GNU General Public License v3.0 only](https://spdx.org/licenses/GPL-3.0-only.html).
 
 ## Contributors
 

package.json

@@ -2,30 +2,27 @@
   "name": "simde",
   "version": "2.3.0",
   "description": "Educational superescalar and VLIW simulator",
-  "type": "module",
-  "packageManager": "[email protected]",
-  "scripts": {
-    "dev": "vite",
-    "build": "tsc && vite build",
-    "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
-    "test": "vitest",
-    "docs": "typedoc src/index.ts --excludePrivate --mode file --theme minimal --out build/docs && opn build/docs/index.html",
-    "docs:json": "typedoc --mode file --json build/docs/typedoc.json src/index.ts",
-    "cov": "vitest run --coverage",
-    "check-coverage": "nyc check-coverage --lines 70 --functions 70 --branches 70",
-    "html-coverage": "nyc report --reporter=html",
-    "send-coverage": "nyc report --reporter=lcov > coverage.lcov && codecov"
+  "homepage": "https://github.com/SIMDE-ULL/SIMDE",
+  "bugs": {
+    "url": "https://github.com/SIMDE-ULL/SIMDE/issues"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/etsiiull/SIMDE.git"
+    "url": "git+https://github.com/SIMDE-ULL/SIMDE.git"
   },
-  "author": "Adrian Abreu Gonzalez",
-  "license": "GPLv3",
-  "bugs": {
-    "url": "https://github.com/etsiiull/SIMDE/issues"
+  "license": "GPL-3.0",
+  "author": "The SIMDE devs",
+  "type": "module",
+  "scripts": {
+    "build": "tsc && vite build",
+    "check": "biome check --apply ./src",
+    "dev": "vite",
+    "docs": "typedoc src/index.ts --excludePrivate --mode file --theme minimal --out build/docs",
+    "fmt": "biome format --write ./src",
+    "lint": "biome lint --apply ./src",
+    "test": "vitest --run",
+    "test:coverage": "vitest run --coverage"
   },
-  "homepage": "https://github.com/etsiiull/SIMDE",
   "dependencies": {
     "@fortawesome/fontawesome-free": "^6.5.1",
     "@popperjs/core": "^2.11.8",
@@ -50,22 +47,14 @@
     "tslib": "^2.2.0",
     "typescript-parsec": "^0.3.4"
   },
-  "engines": {
-    "node": ">=18"
-  },
   "devDependencies": {
+    "@biomejs/biome": "^1.6.1",
     "@types/node": "^20.8.9",
     "@types/react": "^18.2.15",
     "@types/react-dom": "^18.2.7",
-    "@typescript-eslint/eslint-plugin": "^7.0.0",
-    "@typescript-eslint/parser": "^7.0.0",
     "@vitejs/plugin-react": "^4.0.3",
     "@vitest/coverage-v8": "^1.0.0",
     "codecov": "^3.6.5",
-    "eslint": "^8.45.0",
-    "eslint-plugin-react-hooks": "^4.6.0",
-    "eslint-plugin-react-refresh": "^0.4.3",
-    "multiview": "3.0.1",
     "sass": "^1.69.5",
     "stylelint": "^16.0.0",
     "stylelint-config-standard-scss": "^13.0.0",
@@ -74,5 +63,9 @@
     "typescript": "^5.0.2",
     "vite": "^5.0.0",
     "vitest": "^1.0.0"
+  },
+  "packageManager": "[email protected]",
+  "engines": {
+    "node": ">=18"
   }
 }