|
| 1 | +# 💡 Usage Guide |
| 2 | + |
| 3 | +## 🗂️ File Management |
| 4 | + |
| 5 | +The **LLM Code Reviewer** editor allows you to manage your scripts directly inside the app. |
| 6 | + |
| 7 | +You can: |
| 8 | +- ➕ **Add** new files |
| 9 | +- ✏️ **Edit** existing ones |
| 10 | +- 🧾 **Rename** scripts |
| 11 | +- ❌ **Delete** unnecessary files |
| 12 | + |
| 13 | +Each script is stored locally and automatically saved to disk. |
| 14 | + |
| 15 | +--- |
| 16 | + |
| 17 | +## 🧠 Syntax Highlighting |
| 18 | + |
| 19 | +When a file has a recognized extension, the editor automatically applies syntax highlighting. |
| 20 | + |
| 21 | +Supported formats: |
| 22 | +- `.cs` — C# |
| 23 | +- `.py` — Python |
| 24 | +- `.json` — JSON |
| 25 | +- `.xml` — XML |
| 26 | +- `.html`, `.css`, `.js`, `.md` — common text formats |
| 27 | + |
| 28 | +Unknown extensions are opened as plain text. |
| 29 | + |
| 30 | +--- |
| 31 | + |
| 32 | +## 💾 Saving and Storage |
| 33 | + |
| 34 | +All scripts are saved automatically to your user profile folder. |
| 35 | + |
| 36 | +| OS | Location | |
| 37 | +|----|-----------| |
| 38 | +| 🪟 **Windows** | `C:\Users\<username>\AppData\Roaming\LLMCodeReviewer\scripts.json` | |
| 39 | +| 🍎 **macOS** | `/Users/<username>/Library/Application Support/LLMCodeReviewer/scripts.json` | |
| 40 | +| 🐧 **Linux** | `/home/<username>/.config/LLMCodeReviewer/scripts.json` | |
| 41 | + |
| 42 | +The editor will create the folder automatically if it doesn’t exist. |
| 43 | +Your data is persistent between sessions. |
| 44 | + |
| 45 | +--- |
| 46 | + |
| 47 | + |
| 48 | +## 🤖 LLM AI Bot Integration |
| 49 | + |
| 50 | +You can launch the built-in **AI Assistant** directly from the editor. |
| 51 | +It provides: |
| 52 | +- Code analysis based on recent changes |
| 53 | +- Diff summarization and issue detection |
| 54 | +- Context-aware insights for refactoring |
| 55 | + |
| 56 | +📄 See more: [LLM Commands & Bot Usage →](docs/llm-commands.md) |
| 57 | + |
| 58 | + |
| 59 | +## 🖥️ Editor Preview |
| 60 | + |
| 61 | +Below is an example of the code editor interface with syntax highlighting enabled: |
| 62 | + |
| 63 | + |
| 64 | + |
| 65 | +*(You can replace this image with your own screenshot stored in `/assets/`.)* |
| 66 | + |
| 67 | +--- |
| 68 | + |
| 69 | +✅ **That’s it!** |
| 70 | +You’re ready to use **LLM Code Reviewer** as your AI-powered, cross-platform code editor. |
0 commit comments