Skip to content

table of contents in core.adoc #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bvbasavaraju merged 10 commits into from
Aug 3, 2025
Merged

table of contents in core.adoc #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
2388c10
:sparkles:
bvbasavaraju Apr 28, 2025
5eee35a
chip8 examples
bvbasavaraju Jun 8, 2025
72d8015
added the link for Chip8 games.
bvbasavaraju Jun 8, 2025
25b41d4
:memo: added little details on the emulator implementation and core a…
bvbasavaraju Aug 3, 2025
311305c
updated ASCII doc for more details
bvbasavaraju Aug 3, 2025
418efbe
Merge branch 'main' into user/bv/doc/impl_details_api_reference
bvbasavaraju Aug 3, 2025
737a559
updated to create separate pages for ascii doc
bvbasavaraju Aug 3, 2025
b155f20
fixed the link issue
bvbasavaraju Aug 3, 2025
2251db3
Merge branch 'main' into user/bv/doc/impl_details_api_reference
bvbasavaraju Aug 3, 2025
8b60abf
added table fo contents for code.adoc
bvbasavaraju Aug 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/chip8_emu.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,4 @@ By separating opcode decoding, operand handling, and instruction execution, the

Details on design and implementation of a clean API for the core emulator logic, allowing users to interact with the emulator without needing to understand its internal workings can be found below. The APIs provide methods for fetching, decoding, and executing instructions, as well as loading programs and accessing emulator resources.

link:core.adoc[Core Emulator API Reference]
link:core.html[Core Emulator API Reference]
4 changes: 4 additions & 0 deletions docs/core.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
:source-language: c++
:toc: left
:toclevels: 4

== Core Emulator API Reference

The `core_t` class is the central component of the Chip8 emulator, managing the main emulation cycle and resources. It provides a clean interface for fetching, decoding, and executing instructions, as well as loading programs and accessing emulator resources.
Expand Down