diff --git a/README.md b/README.md index 80a6d2b8..68d5d1eb 100644 --- a/README.md +++ b/README.md @@ -31,10 +31,11 @@ By default this will build all targets. - **yaze**: Editor Application - **yaze_c**: C Library - **yaze_py**: Python Module +- **yaze_ext**: Extensions Library - **yaze_test**: Unit Tests - **z3ed**: Command Line Interface -Dependencies are included as submodules and will be built automatically. +Dependencies are included as submodules and will be built automatically. For those who want to reduce compile times, consider installing the dependencies on your system. See [build-instructions.md](docs/build-instructions.md) for more information. ## Documentation diff --git a/docs/build-instructions.md b/docs/build-instructions.md index 7fd38966..384710e5 100644 --- a/docs/build-instructions.md +++ b/docs/build-instructions.md @@ -2,8 +2,10 @@ For VSCode users, use the following CMake extensions -https://marketplace.visualstudio.com/items?itemName=twxs.cmake -https://marketplace.visualstudio.com/items?itemName=ms-vscode.cmake-tools +- https://marketplace.visualstudio.com/items?itemName=twxs.cmake +- https://marketplace.visualstudio.com/items?itemName=ms-vscode.cmake-tools + +For those who want to reduce compile times, consider installing the dependencies on your system. ## Windows diff --git a/docs/infrastructure.md b/docs/infrastructure.md index f17dbc5e..bc61811f 100644 --- a/docs/infrastructure.md +++ b/docs/infrastructure.md @@ -1,4 +1,4 @@ -# YAZE Infrastructure Overview +# Infrastructure Overview For developers to reference. @@ -32,8 +32,6 @@ For developers to reference. - **assets**: Hosts assets like fonts, icons, assembly source, etc. - **cmake**: Contains CMake configurations. - **docs**: Contains documentation for users and developers. - - [Getting Started](./getting-started.md) - - [LC_LZ2 Compression](./compression.md) - **src**: Contains source files. - **app**: Contains the GUI editor `yaze` - **base**: Contains the base data headers for `yaze_c` @@ -67,16 +65,17 @@ For developers to reference. - [app/editor/screen_editor.cc](../src/app/editor/screen_editor.cc) - [app/editor/sprite_editor.cc](../src/app/editor/sprite_editor.cc) -## ROM +## Rom + - [app/rom.cc](../src/app/rom.cc) - [app/rom.h](../src/app/rom.h) -This `ROM` class provides methods to manipulate and access data from a ROM. +The `Rom` class provides methods to manipulate and access data from a ROM. ## Bitmap - [app/gfx/bitmap.cc](../src/app/gfx/bitmap.cc) - [app/gfx/bitmap.h](../src/app/gfx/bitmap.cc) -This class is responsible for creating, managing, and manipulating bitmap data, which can be displayed on the screen using the ImGui library. +This class is responsible for creating, managing, and manipulating bitmap data, which can be displayed on the screen using SDL2 Textures and the ImGui draw list.