Skip to content

Commit

Permalink
Update Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gafert authored Mar 28, 2021
1 parent 13ece40 commit d26861d
Showing 1 changed file with 35 additions and 7 deletions.
42 changes: 35 additions & 7 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,43 @@
![Build/release](https://github.com/gafert/Apate/workflows/Build/release/badge.svg)
![Build/release](https://github.com/gafert/Apate/workflows/Build/release/badge.svg) ![GitHub all releases](https://img.shields.io/github/downloads/gafert/apate/total?color=blue)

# Apate - a visual CPU Simulator
# Apate - a visual CPU simulator for use in education

Download the latest build for Windows, macOS or Linux in the [releases](https://github.com/gafert/Apate/releases)
This simulator is a tool for students to learn the inner workings of a CPU. Based on the RISC V instruction set (RV32I) it provides a visual step by step guide through the flow of a CPU. __[Watch the introduction video!](https://onedrive.live.com/embed?cid=7DB401F01603F3FF&resid=7DB401F01603F3FF%21387672&authkey=AIt0zApVbDVJKUc)__

This simulator is a tool for students to learn the inner workings of a CPU. Based on the RISC V instruction set (RV32I) it provides a visual step by step guide through the flow of a CPU.
<table>
<tr>
<th>
Windows
</th>
<th>
macOS
</th>
<th>
Linux
</th>
</tr>
<tr>
<td>
<a href="https://github.com/gafert/Apate/releases/latest/download/Apate-1.0.4.exe">
<img src="https://img.shields.io/badge/download-Apate--1.0.4.exe-blue" ></a>
</td>
<td>
<a href="https://github.com/gafert/Apate/releases/latest/download/Apate-1.0.4.dmg">
<img src="https://img.shields.io/badge/download-Apate--1.0.4.dmg-blue" href="https://github.com/gafert/Apate/releases/latest/download/Apate-1.0.4.dmg"></a>
</td>
<td>
<a href="https://github.com/gafert/Apate/releases/latest/download/Apate-1.0.4.AppImage">
<img src="https://img.shields.io/badge/download-Apate--1.0.4.AppImage-blue" href="https://github.com/gafert/Apate/releases/latest/download/Apate-1.0.4.AppImage"></a>
</td>
</tr>
<tr>
<td colspan=3>See older versions in the <a href="https://github.com/gafert/Apate/releases">releases</td>
</tr>
</table>

![Screenshot](https://github.com/gafert/Apate/blob/master/res/apate.png?raw=true)

## Features
# Features

* Step by step guid trough the CPU
* See the current instruction and what that instruciton does
Expand All @@ -19,7 +48,7 @@ This simulator is a tool for students to learn the inner workings of a CPU. Base
* Complex CPU elements simplified
* Not focused on speed, verification, completeness or correct depiction of HDL but on principles of teaching

## Under the hood
# Under the hood

* Runs on [electron](https://www.electronjs.org/)
* Visualisation with [three.js](https://github.com/mrdoob/three.js) and SVGLoader
Expand All @@ -34,4 +63,3 @@ Thank you to [@jameslzhu](https://github.com/jameslzhu) for [RISC V Reference Sh




0 comments on commit d26861d

Please sign in to comment.