mirror of
https://github.com/pound-emu/ballistic.git
synced 2026-01-31 01:15:21 +01:00
docs: Add compilation guide to readme
Signed-off-by: Ronald Caesar <github43132@proton.me>
This commit is contained in:
54
README.md
54
README.md
@@ -7,3 +7,57 @@
|
||||
# Overview
|
||||
|
||||
This is a rewrite the dynarmic recompiler, with the goal of fixing its many flaws.
|
||||
|
||||
# Building Ballistic
|
||||
|
||||
## Install Dependancies
|
||||
|
||||
### macOS
|
||||
|
||||
```bash
|
||||
brew install cmake python3
|
||||
brew install cmark llvm
|
||||
```
|
||||
|
||||
### Debian/Ubuntu
|
||||
|
||||
```bash
|
||||
sudo apt update
|
||||
sudo apt install build-essential cmake python3
|
||||
sudo apt install libcmark-dev libclang-dev llvm-dev
|
||||
```
|
||||
|
||||
### Fedora
|
||||
|
||||
```bash
|
||||
sudo dnf install cmake python3 gcc-c++ cmark-devel clang-devel llvm-devel
|
||||
```
|
||||
|
||||
## Configure CMake
|
||||
|
||||
```bash
|
||||
mkdir build
|
||||
cd build
|
||||
cmake ..
|
||||
```
|
||||
|
||||
### macOS (If LLVM is not found)
|
||||
|
||||
```bash
|
||||
cmake -DCMAKE_PREFIX_PATH=$(brew --prefix llvm) ..
|
||||
```
|
||||
## Build Binaries
|
||||
|
||||
```bash
|
||||
cmake --build .
|
||||
```
|
||||
|
||||
The following executables will be created in the `build/` directory:
|
||||
* `libBallistic.a` (Static Library)
|
||||
* `ballistic_cli` (Used for Ballistic development)
|
||||
* `decoder_cli` (Instruction decoding tool)
|
||||
* `cdoc` (Documentation generator)
|
||||
* `ballistic_tests` (Test suite)
|
||||
|
||||
See [tools/](tools/) for more information on these executables.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user