diff --git a/CMakeLists.txt b/CMakeLists.txt index a0d9057..7e198c7 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -14,4 +14,4 @@ target_link_libraries(TemplateApp PUBLIC ) # Register the application class -RegisterApplicationClass(Template) \ No newline at end of file +RegisterApplicationClass(ExampleApp) diff --git a/Template.cpp b/ExampleApp.cpp similarity index 66% rename from Template.cpp rename to ExampleApp.cpp index 16f507f..f77a9d3 100644 --- a/Template.cpp +++ b/ExampleApp.cpp @@ -1,16 +1,15 @@ -#include "Template.h" +#include "ExampleApp.h" // Run once -void Template::Setup() { +void ExampleApp::Setup() { // Write Logics that happens when app first starts } // Run in a loop after Setup() -void Template::Loop() { +void ExampleApp::Loop() { // Write logics that should keep happens - } -void Template::End() { +void ExampleApp::End() { // Write logic that should happen when app exits } diff --git a/Template.h b/ExampleApp.h similarity index 71% rename from Template.h rename to ExampleApp.h index 5e4c1b1..ee55d23 100644 --- a/Template.h +++ b/ExampleApp.h @@ -1,16 +1,12 @@ -/* -This is the template application for Matrix OS -*/ - #pragma once #include "MatrixOS.h" #include "Application.h" -class Template : public Application { +class ExampleApp : public Application { public: inline static Application_Info info = { - .name = "Template", + .name = "ExampleApp", .author = "203 Systems", .color = Color(0xFFFFFF), .version = 1, diff --git a/README.md b/README.md index bf6b562..c58fd0f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # MatrixOS Application Template -A template repository for creating C++ native applications for [MatrixOS](https://github.com/203System/MatrixOS) +A template repository for creating C++ native applications for [MatrixOS](https://github.com/203-Systems/MatrixOS) ## 🚀 Quick Start @@ -9,12 +9,11 @@ A template repository for creating C++ native applications for [MatrixOS](https: 3. Rename files and update the application name: - Rename `ExampleApp.h` → `YourAppName.h` - Rename `ExampleApp.cpp` → `YourAppName.cpp` - - Update class name from `ExampleApp` to `YourAppName` in all files - - Update `APP_NAME` in `CMakeLists.txt` + - Update class name from `ExampleApp` to `YourAppName` in all files (`.cpp`, `.h`, `.txt`) 4. Add more cpp or h files and Implement your application logic. -5. Add your app to MatrixOS (see [Installation](#installation)) +5. Add your app to MatrixOS -## 🛠️ Installation +## 🛠️ Installation on MatrixOS ### Method 1: Git URL (Recommended) @@ -114,14 +113,14 @@ MatrixOS provides a comprehensive UI framework for building interactive interfac - **UIComponents** - Pre-built components like buttons, selectors, menus, and more - **UIUtility** - Helper functions for common UI patterns (number input, text display, etc.) -To use the UI framework, create UI objects within your application and call their `Start()` method to enter UI. See the UI components in [OS/UI/](https://github.com/203System/MatrixOS/tree/main/OS/UI) for available components. +To use the UI framework, create UI objects within your application and call their `Start()` method to enter UI. See the UI components in [OS/UI/](https://github.com/203-Systems/MatrixOS/tree/main/OS/UI) for available components. - And many more... -For complete documentation of all available APIs, refer to [Project Matrix Wiki](matrix.203.io) and [OS/MatrixOS.h](https://github.com/203-Systems/MatrixOS/blob/main/OS/MatrixOS.h). +For complete documentation of all available APIs, refer to [Project Matrix Wiki](https://matrix.203.io) and [OS/MatrixOS.h](https://github.com/203-Systems/MatrixOS/blob/main/OS/MatrixOS.h). ## 🔗 Resources -- [Project Matrix Wiki](matrix.203.io) -- [MatrixOS Repository](https://github.com/203System/MatrixOS) +- [Project Matrix Wiki](https://matrix.203.io) +- [MatrixOS Repository](https://github.com/203-Systems/MatrixOS) - [Discord Community](https://discord.gg/rRVCBHHPfw)