Skip to content

Commit 55aefcf

Browse files
authored
Update Docs (#16)
1 parent 546cbb7 commit 55aefcf

File tree

1 file changed

+19
-9
lines changed

1 file changed

+19
-9
lines changed

README.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,8 @@
66
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
77
[![Licence MIT](https://img.shields.io/packagist/l/doctrine/orm.svg?maxAge=2592000?style=plastic)](https://github.com/hugsy/bochscpu-python/blob/main/LICENSE)
88

9+
Python bindings for [@yrp](https://github.com/yrp604/)'s [BochsCPU](https://github.com/yrp604/bochscpu) using [FFI](https://github.com/yrp604/bochscpu-ffi) to easily and accurately emulate x86 code.
910

10-
Python bindings for [@yrp](https://github.com/yrp604/)'s [BochsCPU](https://github.com/yrp604/bochscpu) using [FFI](https://github.com/yrp604/bochscpu-ffi)
11-
12-
![image](https://i.imgur.com/YvXg2Tz.png)
1311

1412
## Install
1513

@@ -55,7 +53,7 @@ Note that this approach will require you to have all the building tools necessar
5553
* Python 3.8+ (with development kit)
5654
* `cmake`
5755
* `pip`
58-
* a C++20 compatible compiler (tested `cl` for Windows, `clang` for Linux)
56+
* a C++20 compatible compiler (tested `cl` for Windows, `clang++` for MacOS and `g++` Linux)
5957

6058
### Steps
6159

@@ -75,12 +73,24 @@ python -m pip wheel .
7573

7674
Just import the `bochscpu` module and let the fun begin! Installing the package will also install interface files, allowing modern IDEs (VSCode, PyCharm, etc.) to offer useful completion.
7775

78-
## Enjoy 🍻
7976

80-
## TODO
77+
## Gallery
78+
79+
### Emulate a Fibonascii sequence in x64 long mode
80+
81+
![image](https://github.com/hugsy/bochscpu-python/assets/590234/037e581f-c57d-4b0b-a136-6925ceecfbca)
82+
83+
84+
### Emulate code from a Windows 11 x64 memory dump
85+
86+
![image](https://github.com/hugsy/bochscpu-python/assets/590234/2ea77b17-cf59-4ec3-a38b-602d63e201f8)
87+
88+
89+
### Emulate a `print("hello world")`-like assembly code in 16 bit real mode
90+
91+
![image](https://github.com/hugsy/bochscpu-python/assets/590234/1a49d9ef-f18a-4943-b483-4c59e64ffa82)
92+
93+
## Enjoy 🍻
8194

82-
* [ ] Add more complete examples
83-
* [ ] Add basic usage examples
84-
* [ ] Add API docs
8595

8696

0 commit comments

Comments
 (0)