Skip to content

Commit dfbf4ac

Browse files
authored
Update README.md
1 parent e5377cd commit dfbf4ac

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,16 @@ KDevCXX with AI is an innovative extension for the KDevelop IDE and Kate Editor,
1414
## Planned Features
1515

1616
- **Multiple Presets** for AI query assistant working with new and existing code, explanation providing information with tools windows, refactor for refactoring old code
17-
- **Add kdevelop settings kcm ui** for easier settings access
18-
- **Kate plugin** reusing plugin code with conditional build as Kate plugin
1917
- **Chat with GPT windows** producing desired result with finall button apply to move result to code editor window.
2018

2119
## Getting Started
2220

2321
### Prerequisites
2422

25-
- KDevelop IDE installed on your system.
23+
- KDevelop IDE installed on your system for kdevelop plugin
24+
- Kate Editor installed on your system for kate plugin
2625
- Internet connection for accessing AI features.
2726

28-
2927
## Required System Packages
3028

3129
- **CMake**: Required to configure the build system.
@@ -72,29 +70,30 @@ Use CMake to build the plugin with the following command:
7270
```bash
7371
cmake --workflow --preset="clang-release"
7472
```
73+
kate plugin will be build and if kdevplatform development headers and libraries are present then kdevelop plugin will be build also.
7574

7675
### 3. Install the Plugin
7776

78-
Use provided install.sh script it will determine location of kdevplatform plugins and install plugin into that directory
77+
Use provided install_kdeveplugin.sh and or install_kateplugin.sh scripts it will determine location of kdevplatform plugins and qt/plugins for texteditor and install plugins into that directories
7978

8079

8180
### 4. Configure OpenAI Key
8281

83-
Upon launching KDevelop, a modal dialog will appear, prompting you to review and update your settings in KDeelop settings dialog.
82+
Upon launching KDevelop, a modal dialog will appear, prompting you to review and update your settings in KDevelop settings dialog.
83+
For kate You need to go Kate settings and enable plugin and edit them.
84+
Note that ai settings are shared between kate and kdevelop, so You only need to do it once.
8485

8586
## Usage
8687

87-
After installing the plugin, restart KDevelop. The AI features should now be seamlessly integrated into your IDE.
88+
After installing the plugin, restart KDevelop/Kate. The AI features should now be seamlessly integrated into your IDE.
8889

8990
To use the AI functionality within the editor, follow these steps:
9091

91-
1. Write your AI request in the editor, preceded by `[AI DO something for me with that code]`, followed by the code you wish AI to analyze or modify.
92+
1. Write your AI request in the editor, preceded by `[AI Do something for me with that code]`, followed by the code/text you wish AI to analyze or modify.
9293

9394
2. Highlight the request and the target code.
9495

95-
3. Press `Ctrl + 1` or select from Drop down menu `Process with AI` to activate the AI processing of selected request and code in format \[AI perform command \]. With 0.1.3 there is context menu available `Process With OpenAI`
96-
97-
96+
3. Select from Drop down menu `Process with AI` to activate the AI processing of selected request and code in format \[AI perform command \].
9897

9998

10099
## Example use
@@ -126,6 +125,10 @@ And perhaps the most weird use of AI i did with code, optimise ai query with ai
126125

127126
![obraz](https://github.com/arturbac/kdevcxx_with_ai/assets/14975842/a4ec262c-e805-4252-ab45-01b59be4ce38)
128127

128+
Or some crazy s...
129+
130+
![obraz](https://github.com/arturbac/kdevcxx_with_ai/assets/14975842/952db481-e76a-4935-a812-5cb10c951421)
131+
129132

130133
## License
131134

0 commit comments

Comments
 (0)