Initial Home page

VetheonGames 2023-06-08 11:25:11 -06:00
commit f8a8a5432b

23
Home.md Normal file

@ -0,0 +1,23 @@
# Welcome to the DynamicCursesInput Wiki!
This Wiki is designed to provide comprehensive documentation on the DynamicCursesInput gem. It is divided into two main sections: "Methods and Classes Explained" and "Examples".
## Table of Contents
### Methods and Classes Explained
This section provides detailed explanations of the classes and methods used in the DynamicCursesInput gem. Each class and method has its own page, which includes a description of its purpose, its parameters, and its return value.
1. [InputHandler Class](wiki/InputHandler)
2. [CursorMover Class](wiki/CursorMover)
3. [CharacterDeleter Class](wiki/CharacterDeleter)
4. [CharacterAdder Class](wiki/CharacterAdder)
### Examples
This section provides practical examples of how to use the DynamicCursesInput gem in your projects. Each example has its own page, which includes a description of the example, the code, and an explanation of how the code works.
1. [Basic Usage Example](wiki/Basic-Usage-Example)
2. [Advanced Usage Example](wiki/Advanced-Usage-Example)
We hope this Wiki helps you understand how to use the DynamicCursesInput gem effectively. If you have any questions or suggestions, please feel free to [contact us](mailto:vetheon@pixelatedstudios.net).