Skip to content

Commit

Permalink
Small fixes in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pkoppe committed Nov 6, 2023
1 parent 0b7c044 commit 75bd87d
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ Nyxstone is an assembly and disassembly library based on LLVM. It doesn’t requ
1. [Prerequisites](#prerequisites)
2. [As a Rust library](#as-a-rust-library)
3. [As a Python library](#as-a-python-library)
4. [As a C++ library](#as-a-c++-library)
5. [C++ CLI Tool](#c++-cli-tool)
4. [As a C++ library](#as-a-c-library)
5. [C++ CLI Tool](#c-cli-tool)
3. [How it works](#how-it-works)
4. [License](#license)
5. [Contributing](#contributing)
Expand Down Expand Up @@ -96,9 +96,9 @@ Install Nyxstone with pip. On some distributions you may have to create a virtua
´´´
$ pip install nyxstone
$ python -q
>>> from nyxstone import NyxstoneBuilder
>>> nyxstone = NyxstoneBuilder().with_triple("x86_64").build()
>>> nyxstone.assemble_to_bytes("jne .loop", 0x1100, {".loop": 0x1000})
\>\>\> from nyxstone import NyxstoneBuilder
\>\>\> nyxstone = NyxstoneBuilder().with_triple("x86_64").build()
\>\>\> nyxstone.assemble_to_bytes("jne .loop", 0x1100, {".loop": 0x1000})
´´´

For more instructions regarding the Python binding, refer to its [README](bindings/python/README.md).
Expand All @@ -123,6 +123,8 @@ add_executable(my_executable main.cpp)
target_link_libraries(my_executable nyxstone ${llvm_libs})
```

C++ usage example.

```c++
#include <cassert>
#include <iostream>
Expand Down Expand Up @@ -153,7 +155,7 @@ Nyxstone also comes with a handy CLI tool for quick assembly and disassembly tas
```
$ apt install boost
$ mkdir build && cd build && cmake .. && make
$ mkdir build && cd build && cmake .. && make # run in nyxstone folder
```
Help message output.
Expand Down

0 comments on commit 75bd87d

Please sign in to comment.