Skip to content

Commit 1394364

Browse files
committed
README update
1 parent d00c905 commit 1394364

File tree

3 files changed

+31
-6
lines changed

3 files changed

+31
-6
lines changed

README.md

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,37 @@ Debugger for the Atari Lynx emulator [Handy](https://handy.sourceforge.net/).
44

55
Based on ImGui, GLFW/Vulkan, reasonably cross platform (Linux - GCC 12.1, Windows - Visual Studio 2022).
66

7-
To load symbols create file with the same name as the cart but with the .lbl extension.
8-
The *lbl* file can be a Vice label file (generated by [cl65](https://cc65.github.io/doc/cl65.html) -Ln option) or simply be a list of "addr label":
7+
![](/assets/screen1.jpg)
8+
9+
# Binaries
10+
Latest Windows binaries can currently be found on the [releases](https://github.com/LLeny/VkHandybug/releases) page.
11+
12+
# Usage
13+
You will first need to set the Lynx ROM image path, please use the ```MAIN -> Settings...``` menu to do so.
14+
15+
To load symbols create a file with the same name as the cart but with the .lbl extension.
16+
The *lbl* file can be a Vice label file (generated by [cl65](https://cc65.github.io/doc/cl65.html) -Ln option) or simply be a list of "addr label".
917

1018
```
1119
0034 here
1220
4ADE andhere
1321
```
1422

15-
![](/assets/screen1.jpg)
23+
# Building
24+
## Dependencies
25+
26+
- [Vulkan SDK](https://www.lunarg.com/vulkan-sdk/), please refer to your system's [vulkan "Getting Started"](https://www.lunarg.com/vulkan-sdk/) page for installation.
27+
- [CMake](https://cmake.org/) is required as the build files generator.
28+
29+
## Compiling
30+
### Linux
31+
```
32+
git clone https://github.com/LLeny/VkHandybug.git
33+
cd VkHandybug
34+
mkdir build
35+
cd build
36+
cmake -DCMAKE_BUILD_TYPE=Release ..
37+
cmake --build .
38+
```
39+
40+
The binary should be created in the folder ```./bin```

assets/screen1.jpg

259 KB
Loading

tools/cmake.dependencies

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Set(FETCHCONTENT_QUIET FALSE)
33
FetchContent_Declare(
44
miniaudio
55
GIT_REPOSITORY https://github.com/mackron/miniaudio.git
6-
GIT_TAG 9a7663496fc06f7a9439c752fd7666ca93328c20
6+
GIT_TAG 0.11.15
77
GIT_SHALLOW TRUE
88
GIT_PROGRESS TRUE
99
)
@@ -60,7 +60,7 @@ FetchContent_Declare(
6060
cereal
6161
GIT_REPOSITORY https://github.com/USCiLab/cereal.git
6262
GIT_TAG ddd467244713ea4fe63733628992efcdd6a9187d
63-
GIT_SHALLOW TRUE
63+
GIT_SHALLOW FALSE
6464
GIT_PROGRESS TRUE
6565
)
6666

@@ -76,7 +76,7 @@ FetchContent_Declare(
7676
hashlib
7777
GIT_REPOSITORY https://github.com/stbrumme/hash-library.git
7878
GIT_TAG d389d18112bcf7e4786ec5e8723f3658a7f433d7
79-
GIT_SHALLOW TRUE
79+
GIT_SHALLOW FALSE
8080
GIT_PROGRESS TRUE
8181
)
8282

0 commit comments

Comments
 (0)