Skip to content

Commit 8bd6ffa

Browse files
committed
minor changes
1 parent e968da8 commit 8bd6ffa

5 files changed

Lines changed: 73 additions & 5 deletions

File tree

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,4 @@ Integrates with **OpenAI API** for intelligent code review, diff analysis, and a
1010
| [⚙️ Setup (Install · Build · Run)](docs/setup.md) | Complete setup guide: install dependencies, build, and run the app |
1111
| [💡 Usage](docs/usage.md) | How to use the editor, manage scripts, and interact with the UI |
1212
| [🤖 LLM Commands](docs/llm-commands.md) | List of available AI commands and their behavior |
13-
| [🧩 Structure](docs/structure.md) | Overview of main folders and components |
1413
| [🔧 Configuration](docs/configuration.md) | Setting up API keys and environment variables |

assets/aibot.png

214 KB
Loading

assets/editor.png

223 KB
Loading

docs/setup.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
e# ⚙️ Build & Run Guide
1+
⚙️ Build & Run Guide
22

33
## 🔹 1️⃣ Requirements
44

55
- [.NET 9 SDK](https://dotnet.microsoft.com/download)
6-
- Internet connection (for NuGet restore)
7-
- (Optional) [Git](https://git-scm.com/)
6+
- (Optional) [OPEN AI API KEY]
87

98
Check SDK version:
109
```bash
@@ -16,7 +15,7 @@ dotnet --version
1615
## 🔹 2️⃣ Clone & Restore
1716

1817
```bash
19-
git clone https://github.com/yourusername/llm-code-reviewer.git
18+
git clone https://github.com/SanyaKor/llm-code-reviewer.git
2019
cd llm-code-reviewer
2120
dotnet restore
2221
```

docs/usage.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
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+
![Editor Preview](/assets/editor.png)
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

Comments
 (0)