miharu/README.org

[[https://justforfunnoreally.dev][https://img.shields.io/badge/justforfunnoreally-dev-9ff.svg]] [[./LICENSE][https://img.shields.io/badge/License-GPL_v3-blue.svg]]
#+BEGIN_QUOTE
⚡Miharu is an i386 emulator in zig.
#+END_QUOTE

* Introduction
Miharu (見張る) comes from phonetically matching (語呂合わせ) the number 386, from the 80386 intel chip.
The intent behind this project--beyond learning x86 assembly--is to fully emulate an IBM-DOS computer from the early 1980's. An additional interest is in the PC-98, non-IBM DOS system. 
* Build
Currently there are no dependencies for Miharu. To build and run the CLI REPL, simply:

#+begin_src
  guix shell --pure -m=manifest.scm
  zig build run
#+end_src

#+BEGIN_QUOTE
/Miharu is developed and built targeting the latest version of zig./
#+END_QUOTE
* Usage
In it's current state, Miharu is solely a =REPL= based implementation.

#+begin_src 
  
                Mi-Ha-Ru (386) REPL

Miharu Copyright (c) 2024 The Miharu Developers
  This program comes with ABSOLUTELY NO WARRANTY;
  This is free software, and you are welcome
  to redistribute it under certain coditions;
  for details please refer to the LICENSE file.

Type `?` for help.
Type `exit` to quit.
> 
#+end_src
* References
- [[http://www.c-jump.com/CIS77/reference/Instructions_by_Opcode.html][Opcode Reference]]
- [[https://pdos.csail.mit.edu/archive/6.097/readings/intelv2.pdf][Intel Reference Manual]]
- [[https://en.wikipedia.org/wiki/X86_instruction_listings][x86 Instructions By Architecture]]