You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Thank you for your interest in contributing to SIMDE! What follows is a list of possible actions to contribute to this project:
4
+
5
+
* Report any bug you encounter by [filing an issue](https://github.com/SIMDE-ULL/SIMDE/issues).
6
+
7
+
* You can propose new features also by [filing an issue](https://github.com/SIMDE-ULL/SIMDE/issues).
8
+
9
+
* Help by resolving [open issues](https://github.com/SIMDE-ULL/SIMDE/issues?q=is%3Aissue+is%3Aopen), especially those labeled as [_"good first issue"_](https://github.com/SIMDE-ULL/SIMDE/issues?q=is%3Aissue+is%3Aopen+label%3A"good+first+issue").
SIMDE is a simulator for supporting teaching of [ILP (Instruction Level Parallelism)](https://en.wikipedia.org/wiki/Instruction-level_parallelism) Architectures.
14
+
> <palign="center">🖥️ Run <b>SIMDE</b> directly from your browser: <ahref="https://SIMDE-ULL.github.io/SIMDE/">https://SIMDE-ULL.github.io/SIMDE/</a></p>
10
15
11
-
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.
16
+
__SIMDE__is a computer simulator with a strong focus on assisting in learning and education. As a didactic simulator, SIMDE aims to supercharge the teaching of [computer architecture]((https://en.wikipedia.org/wiki/Computer_architecture)) principles with a pragmatic, _learn-by-doing_ approach.
12
17
13
-
This make easier to learn concepts suchs as *Tomasulo's algorithm* and the purpose of structures such as the reorderbuffer.
18
+
When used in supporting educational practices, SIMDE shines both for reproducing architectural concepts, such as [_Tomasulo's algorithm_](https://en.wikipedia.org/wiki/Tomasulo%27s_algorithm) and representing organizational structures, like [_re-order buffers_](https://en.wikipedia.org/wiki/Re-order_buffer).
14
19
15
-
## Technologies
20
+
## This is how SIMDE looks in action
16
21
17
-
SIMDE is powered by Typescript, React, Redux, Sass and Webpack.
22
+
18
23
19
-
## How to use
24
+
## Features
20
25
21
-
[Go to the project website and start learning](https://etsiiull.github.io/SIMDE/)
26
+
* Designed to be simple and enjoyable to use.
27
+
* Includes several forms of visualizing computer units and memory data.
28
+
* Cross-platform, accessible from any modern web browser.
29
+
*_Superscalar_ architecture simulation.
30
+
*_Very Long Instruction Word_ (VLIW) architecture simulation.
31
+
* Multiple instruction processing modes, including [batch processing](https://en.wikipedia.org/wiki/Batch_processing).
32
+
* Instruction flow tracing to visually follow instructions through the pipeline.
33
+
* Project uses modern development standards.
34
+
*_Free_ as in _Freedom_ (see [License](#license) further below).
22
35
23
-
## Development
36
+
## Getting started
24
37
25
-
SIMDE is build on top of typescript,sass and webpack. In order to make the build easier a docker file environment has been added.
26
-
Just install docker and docker-compose and type:
38
+
### Using the official web instance
27
39
28
-
`docker-compose up`
40
+
SIMDE can be accessed directly from any modern browser of your choice at:
29
41
30
-
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.
44
+
## Building from sources
33
45
34
-
##Troubling?
46
+
### Prerequisites
35
47
36
-
If you have any doubt you should check [the official docs](https://etsiiull.gitbooks.io/simde/).
48
+
Make sure that the following tools are installed in your system:
37
49
38
-
## License
50
+
*[Node.js](https://nodejs.org/en) (version >=18).
51
+
*[Yarn](https://yarnpkg.com/) (version >=4).
52
+
53
+
### Build steps
54
+
55
+
1. Install the project dependencies:
56
+
```bash
57
+
yarn install --immutable --immutable-cache
58
+
```
59
+
60
+
2. Build the static site:
61
+
```bash
62
+
yarn build
63
+
```
64
+
65
+
The generated build will be available in the `dist/` directory generated in the root directory of the project. The static files can be served using a HTTP server, such as [Apache httpd](https://httpd.apache.org/), [NGINX](https://www.nginx.com/) or [Traefik](https://traefik.io/).
39
66
40
-
The project has been released under GPLv3 License.
67
+
## Contributing
68
+
See [CONTRIBUTING](CONTRIBUTING.md).
41
69
42
70
## Contributors
43
71
@@ -60,3 +88,9 @@ The project has been released under GPLv3 License.
60
88
<!-- prettier-ignore-end -->
61
89
62
90
<!-- ALL-CONTRIBUTORS-LIST:END -->
91
+
92
+
## License
93
+
94
+
SIMDE is licensed under the [GNU General Public License v3.0 only](https://spdx.org/licenses/GPL-3.0-only.html).
95
+
96
+
The rationale behind this decision is that we, the SIMDE authors, believe that society must strive for free, accessible, high quality educational resources. Given that, SIMDE will always be _"Free as in Freedom"_ for anyone to use anywhere, at any time.
0 commit comments