Skip to content

Commit 7f88c45

Browse files
committed
docs(README): update
1 parent bee9868 commit 7f88c45

File tree

2 files changed

+23
-46
lines changed

2 files changed

+23
-46
lines changed

README.md

Lines changed: 8 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
**`roo-rocket`**, an extends of `config-rocket`, is a toolkit/engine (and a community webpage coming soon!) that helps you create or install configurable config packs, specfically targeting `Roo Code`.
1414

1515
In simple words, **`Roo Rocket`** help you easily install `Roo Code` configurations, which can have these features:
16-
+ 🔫 Optimized `Footgun` prompts (system prompt overrides)
16+
+ 🔫 (Dangerously) optimized `Footgun` prompts (system prompt overrides)
1717
+ 📑 Memory Banks
1818
+ 🐱🦁🐯🐻 Smart / Custom Modes
1919
+ 📚🕹️🔎 MCPs!
@@ -33,15 +33,15 @@ In simple words, **`Roo Rocket`** help you easily install `Roo Code` configurati
3333

3434
## Rationale
3535

36-
`Roo Code` is shipping some amazing enhancements for customizations, and there's no centralized community and toolkit yet, so, let's build one!
36+
The strength of `Roo Code` lies in its customization power, and there's no centralized community and toolkit yet, so, let's build one!
3737

3838
## Usage (for users)
3939

4040
```sh
4141
# On any platform: `Mac / Linux / Windows`, run a command:
4242
npx roo-rocket --repo="NamesMT/config-packs"
4343

44-
# Interactively config your troop if config pack have parameters
44+
# Interactively configure the installation parameters (if any)
4545
# Nothing more, enjoy :)
4646
```
4747

@@ -50,7 +50,7 @@ npx roo-rocket --repo="NamesMT/config-packs"
5050
* There are two ways to start:
5151
* For the full experience:
5252
* Generate a repo from [`config-packs-template`](https://github.com/NamesMT/config-packs-template)
53-
* It's a template to create your own `config packs` for `config-rocket` ecosystem.
53+
* > It's a template to create your own `config packs` for `config-rocket` ecosystem.
5454
* Check `roo-rocket` rules here: [libs/roo-rocket](./libs/roo-rocket/README.md)
5555
* Or a simple, fast start: just create a zip archive of your configuration files!
5656
* *Tip: you can use
@@ -60,50 +60,12 @@ npx roo-rocket --repo="NamesMT/config-packs"
6060

6161
## Notes:
6262

63-
### RR Terms Explained:
64-
65-
* `RR`: short for `Roo Rocket`
66-
67-
* `rocket assembly` / `config pack` / `troop`:
68-
* Refers to an object that `RR` can use to assemble (build out) configurations files, during installations or development hot reloads.
69-
70-
* `Training your troop` / `Crafting rocket assembly` / `Crafting config pack`:
71-
* Refers to the act of you creating the required structure for `RR` to work.
72-
73-
* `Rocket launch`:
74-
* Refers to the process of the user installing your `troop`, imagine you "ship/launch" your `troop` on a rocket to the user.
75-
76-
* `Rocket launch customize`:
77-
* Refers to the user's ability to configure the launch parameters and receive the wanted `troop`, i.e: with/without memory banks instructions, etc.
78-
79-
## Objectives / Roadmap
80-
81-
* [x] A pretty, *OPTIMIZED* image!
82-
* [x] Finish the initial repo layout.
83-
* [x] Main engine and CLI.
84-
* [x] Ability to assemble the rocket from `frame` and `fuel`.
85-
* [x] Ability to customize the rocket launch using `rocket.config.ts`.
86-
* [x] Ability to bundle the `config pack` for safe distribution.
87-
* [x] CLI: Ability to download and unpack a bundled `config pack`.
88-
* [x] From URL.
89-
* [x] Shortcut for GitHub repo with release.
90-
* [x] Local development app for playground testing.
91-
* [x] Development environment with amazing DX and power.
92-
* [x] DRY: `fuel` context system that allows reusable contexts to be defined and used across multiple files, reducing duplication.
93-
* [x] Configurable: Allowing for users to choose their own flavors of Rocket.
94-
* [x] Creator template for `troop` trainers.
95-
* Public template available: [config-packs-template](https://github.com/NamesMT/config-packs-template)
96-
* [x] Simple setup.
97-
* Installing should be a breeze, simply execute a command, on any platform!
98-
* [ ] Working base prompts
99-
* [ ] Smart, optimized modes
100-
* [ ] A webpage, featuring the community Roo trainers
101-
* [x] Splitting the main engine to a general-purpose `config-rocket`
102-
* [x] Migrate to use `config-rocket` instead of code duplication
63+
### [> RR Terms Explained <](./TERMS_EXPLATION.md)
10364

104-
### References:
65+
## Pending roadmap
10566

106-
`Roo Rocket` is still a work-in-progress, there isn't any feature-complete config packs yet, if you need something similar right now, try my [`RooFlow generic`](https://github.com/NamesMT/RooFlow-generic) config, it's a fork of [`RooFlow`](https://github.com/GreatScottyMac/RooFlow), enter the links to learn more.
67+
* [ ] A webpage, featuring the community Roo trainers
68+
* [ ] Recruit more Roo trainers to join the community, contact me if **YOU** are interested!
10769

10870
## License
10971

TERMS_EXPLATION.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
### RR Terms Explained:
2+
3+
* `RR`: short for `Roo Rocket`
4+
5+
* `rocket assembly` / `config pack` / `troop`:
6+
* Refers to an object that `RR` can use to assemble (build out) configurations files, during installations or development hot reloads.
7+
8+
* `Training your troop` / `Crafting rocket assembly` / `Crafting config pack`:
9+
* Refers to the act of you creating the required structure for `RR` to work.
10+
11+
* `Rocket launch`:
12+
* Refers to the process of the user installing your `troop`, imagine you "ship/launch" your `troop` on a rocket to the user.
13+
14+
* `Rocket launch customize`:
15+
* Refers to the user's ability to configure the launch parameters and receive the wanted `troop`, i.e: with/without memory banks instructions, etc.

0 commit comments

Comments
 (0)