|
1 | | -# NOTE: This is Work in Progress and not yet stable enough for external use. |
| 1 | +# NOTE: This is Work in Progress and not yet stable enough for external use!!! |
2 | 2 |
|
3 | 3 |
|
4 | 4 | # Vibe-Coder |
@@ -29,6 +29,53 @@ flowchart LR |
29 | 29 | - 🔧 **VS Code Integration**: Seamless development experience within VS Code. |
30 | 30 | - ⚡ **Real-time Updates**: Automatic Memory Bank updates triggered by significant events. |
31 | 31 |
|
| 32 | +## Installation |
| 33 | + |
| 34 | +Adding RooFlow to your project is simple: |
| 35 | + |
| 36 | +```bash |
| 37 | +npm install --save-dev ez-vibecoder |
| 38 | +``` |
| 39 | + |
| 40 | +Or with yarn: |
| 41 | + |
| 42 | +```bash |
| 43 | +yarn add --dev ez-vibecoder |
| 44 | +``` |
| 45 | + |
| 46 | +That's it! This installer will: |
| 47 | + |
| 48 | +1. Download all the necessary configuration files for RooCode, Cline, Cursor, and Windsurf from the official repositories |
| 49 | +2. Set up the proper directory structure in your project |
| 50 | +3. Fix duplicate `capabilities` YAML sections in configuration files |
| 51 | +4. Validate the YAML structure of system prompt files |
| 52 | +5. Configure everything to work with VS Code's Roo Code extension |
| 53 | + |
| 54 | +## Requirements |
| 55 | + |
| 56 | +- VS Code with the Roo Code extension installed |
| 57 | +- Node.js |
| 58 | + |
| 59 | +## Manual Installation |
| 60 | + |
| 61 | +If the automatic installation doesn't run (which may happen if npm scripts are disabled in your environment). Please note that if destination files already exist, they wont be overwritten. If you intend to get the latest, please manually delete the files before installation. If your folder doesnt already contain node_modules, it will copy to the root folder of your computer: |
| 62 | + |
| 63 | +```bash |
| 64 | +npm i ez-vibecoder |
| 65 | + |
| 66 | +node node_modules/ez-vibecoder/installer.js |
| 67 | +``` |
| 68 | + |
| 69 | +## After Installation |
| 70 | + |
| 71 | +Start enjoying RooFlow immediately: |
| 72 | + |
| 73 | +1. Open your project in VS Code / Cursor / or WindSurf |
| 74 | +2. Start a new RooCode/Cline chat and select any of the five integrated modes |
| 75 | +3. Experience the benefits of persistent context and optimized workflows! |
| 76 | + |
| 77 | +For full usage instructions, refer to the [original RooFlow documentation](https://github.com/GreatScottyMac/RooFlow). |
| 78 | + |
32 | 79 | # Inspired by and References |
33 | 80 |
|
34 | 81 | ## RooCode Memory Bank |
@@ -58,3 +105,7 @@ Reference: https://windsurf.run/ |
58 | 105 | ## RooFlow Installer |
59 | 106 | Inspired by: https://github.com/amir-arad/rooflow |
60 | 107 |
|
| 108 | + |
| 109 | +## License |
| 110 | + |
| 111 | +[Apache 2.0](LICENSE) |
0 commit comments