usage guides

This commit is contained in:
AI Christianson 2025-02-14 17:04:43 -05:00
parent 1681234ab9
commit 81198f91e8
3 changed files with 47 additions and 0 deletions

11
docs/docs/getting-help.md Normal file
View File

@ -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)

View File

@ -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."
```

View File

@ -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.