From 81198f91e8f530f02ced667927f8604d6d55c02c Mon Sep 17 00:00:00 2001 From: AI Christianson Date: Fri, 14 Feb 2025 17:04:43 -0500 Subject: [PATCH] usage guides --- docs/docs/getting-help.md | 11 +++++++++++ docs/docs/usage/cpp-game.md | 19 +++++++++++++++++++ docs/docs/usage/monorepo.md | 17 +++++++++++++++++ 3 files changed, 47 insertions(+) create mode 100644 docs/docs/getting-help.md create mode 100644 docs/docs/usage/cpp-game.md create mode 100644 docs/docs/usage/monorepo.md diff --git a/docs/docs/getting-help.md b/docs/docs/getting-help.md new file mode 100644 index 0000000..fe13d0f --- /dev/null +++ b/docs/docs/getting-help.md @@ -0,0 +1,11 @@ +# Getting Help + +## Bug Reports and Feature Requests + +If you encounter any issues or have ideas for improvements, please file them on our [GitHub Issues page](https://github.com/ai-christianson/RA.Aid/issues). + +## Community Support + +Join our Discord community to chat with other users and get help: + +- [Join the Discord Server](https://discord.gg/f6wYbzHYxV) diff --git a/docs/docs/usage/cpp-game.md b/docs/docs/usage/cpp-game.md new file mode 100644 index 0000000..7a68c8a --- /dev/null +++ b/docs/docs/usage/cpp-game.md @@ -0,0 +1,19 @@ +# Create a Game using RA.Aid + +RA.Aid can work on almost any kind of software, including writing games in languages like C++. + +## Creating the Initial Game + +To get started with creating a game, you can use RA.Aid with a simple command like: + +``` +ra-aid -m "Create a basic breakout clone in C++ using opengl." +``` + +## Adding Features + +Once your base game is working, you can add features like this: + +``` +ra-aid -m "Add score tracking/display to the main screen." +``` \ No newline at end of file diff --git a/docs/docs/usage/monorepo.md b/docs/docs/usage/monorepo.md new file mode 100644 index 0000000..6c2f3fd --- /dev/null +++ b/docs/docs/usage/monorepo.md @@ -0,0 +1,17 @@ +# Work with an Existing Mono Repo using RA.Aid + +RA.Aid is good at handling complex monorepo projects. For example, if you you have an app set up like this: + +``` +app/ +web/ +backend/ +``` + +You can run RA.Aid at the top level and give it commands like this: + +``` +ra-aid -m "Update the user form to support birthdates. Be sure to also update the DB model and migration scripts." +``` + +RA.Aid will proceed to work on multiple high-level components of your application. \ No newline at end of file