https://github.com/d0iasm/book.rvemu

The book "Writing a RISC-V Emulator from Scratch in 10 Steps".
https://github.com/d0iasm/book.rvemu

Last synced: 11 days ago
JSON representation

The book "Writing a RISC-V Emulator from Scratch in 10 Steps".

• Host: GitHub
• URL: https://github.com/d0iasm/book.rvemu
• Owner: d0iasm
• License: mit
• Created: 2020-02-25T01:21:41.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-05-02T08:13:50.000Z (about 1 year ago)
• Last Synced: 2024-03-01T16:34:49.465Z (4 months ago)
• Language: CSS
• Homepage: https://book.rvemu.app/
• Size: 5.81 MB
• Stars: 128
• Watchers: 12
• Forks: 14
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-stars - book.rvemu - The book "Writing a RISC-V Emulator from Scratch in 10 Steps". (Others)
• awesome-stars - d0iasm/book.rvemu - The book "Writing a RISC-V Emulator from Scratch in 10 Steps". (CSS)

README

        
# Writing a RISC-V Emulator in Rust

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE)

[![GitHub Actions status](https://github.com/d0iasm/book.rvemu/workflows/deploy/badge.svg)](https://github.com/d0iasm/book.rvemu/actions)

[https://book.rvemu.app/](https://book.rvemu.app/)

This is the book for writing a 64-bit RISC-V emulator from scratch in Rust. The book shows you how to implement an emulator step by step. You can run [xv6](https://github.com/mit-pdos/xv6-riscv), a simple Unix-like OS, in your emulator.

## Tool

This book is written by [mdBook](https://github.com/rust-lang/mdBook).

Converts markdown files under `src/` directory to html files under `book` directory.

```

$ mdbook build

```

Watchs markdown files to rebuild on every change.

```

$ mdbook watch

```

Serves the book at `http://localhost:3000`.

```

$ mdbook serve

```

## Deploy

GitHub Actions with [peaceiris/actions-gh-pages](https://github.com/peaceiris/actions-gh-pages) deploys the page to GitHub pages.