Skip to content

Commit af62527

Browse files
committed
feat(readme): update readme and configuration name
1 parent 7c9785a commit af62527

File tree

5 files changed

+21
-45
lines changed

5 files changed

+21
-45
lines changed

README.md

+10-35
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ Feel free to share your feedback or report any issues on our [GitHub repository]
1111
- **Easy Installation**: Simply install extensions and start using FireCoder.
1212
- **Completion Auto Mode**: Enjoy the convenience of automatic code suggestions.
1313
- **Manual Mode**: Switch between auto mode and manual mode for code suggestions.
14-
- **Platform Support**: FireCoder supports Windows, Linux, and macOS.
14+
- **Chat Mode**: Interact with FireCoder through natural language, receiving code suggestions and guidance tailored to your needs.
1515
- **Multi-line Code Suggestions**: Enhance your coding experience with multi-line code suggestions.
16+
- **Platform Support**: FireCoder supports Windows, Linux, and macOS.
1617

1718
### New Experimental Features:
1819

1920
- **GPU Support**: You can now utilize GPU support by adjusting the `firecoder.experimental.useGpu` settings in configuration.
20-
- **Chat Mode**: Explore the new chat mode functionality by adjusting the `firecoder.experimental.chat` settings in configuration.
2121

2222
## Getting Started
2323

@@ -27,29 +27,13 @@ Feel free to share your feedback or report any issues on our [GitHub repository]
2727

2828
## Roadmap
2929

30-
- **Support Chat Mode (WIP - Expected Soon):**
31-
Enable a chat mode where users can interact with the FireCoder to get answers to their coding questions. A conversational interface to enhance your coding experience.
32-
33-
- **Custom Commands (WIP - Expected Soon):**
34-
Create a set of custom commands for common tasks such as writing tests, fixing easy bugs, and more. Tailor FireCoder to your specific development needs with ease.
35-
36-
- **Generate Commit Descriptions (Scheduled for Q1 2024):**
37-
Automate the process of generating descriptive commit messages. Improve the clarity and consistency of your version control history effortlessly.
38-
39-
- **Easy GPU Support (Scheduled for Q1 2024):**
40-
Simplify GPU support installation. Just install FireCoder, and let it seamlessly utilize GPU resources to enhance performance and accelerate your coding tasks.
41-
42-
- **Pull Request Reviews (Scheduled for Q1 2024):**
43-
Facilitate pull request reviews directly within FireCoder. Streamline the code review process and make collaboration smoother for your development team.
44-
45-
- **Cloud Service (Scheduled for Q1 2024):**
46-
Introduce a cloud service to provide optimal performance for users with limited resources on their local machines. Enjoy the power of FireCoder without worrying about hardware constraints.
47-
48-
- **IntelliJ IDEA Support (Scheduled for Q2 2024):**
49-
Extend FireCoder's compatibility to include support for IntelliJ IDEA, broadening the range of IDEs where you can seamlessly integrate our AI assistant.
50-
51-
- **Self-Hosting for Teams (Scheduled for Q2 2024):**
52-
Integrate a self-hosting service designed for larger teams. Users can install a central service, enabling a team of developers to leverage FireCoder collaboratively.
30+
- Custom Commands
31+
- Generate Commit Descriptions
32+
- Easy GPU Support
33+
- Pull Request Reviews
34+
- Cloud Service
35+
- IntelliJ IDEA Support
36+
- Self-Hosting for Teams
5337

5438
We're committed to making FireCoder an indispensable part of your coding toolkit. Stay tuned for updates as we bring these exciting features to life!
5539

@@ -58,15 +42,13 @@ We're committed to making FireCoder an indispensable part of your coding toolkit
5842
#### Minimal Requirements
5943

6044
- **Disk Space:** Minimum 2 GB of free disk space.
61-
- **CPU:** Support AVX2.
6245
- **RAM:** Minimum 1 GB of available memory.
6346

6447
These are the minimum specifications to run the FireCoder. The extension should function, but performance may be limited.
6548

6649
#### Optimal Requirements
6750

6851
- **Disk Space:** 14 GB or more of free disk space.
69-
- **CPU:** Support AVX2.
7052
- **RAM:** 6 GB or more of available memory.
7153

7254
If you intend to utilize the high-power and large model features, it is advisable to use a system with enhanced specifications to achieve better performance.
@@ -80,11 +62,4 @@ If you intend to utilize the high-power and large model features, it is advisabl
8062

8163
## Release Notes
8264

83-
### Version 0.0.4
84-
85-
- Auto download model and server.
86-
87-
### Version 0.0.1 (Initial Release)
88-
89-
- Welcome to the first release of FireCoder.
90-
- Download now to explore the possibilities.
65+
See [Github Releases](https://github.com/FireCoderAI/firecoder/releases)

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@
108108
"default": false,
109109
"description": "Use experimental GPU Metal support for macOS."
110110
},
111-
"firecoder.experimental.chat": {
111+
"firecoder.local.chat.use": {
112112
"type": "boolean",
113113
"default": false,
114114
"description": "Enable experimental chat feature."

src/common/panel/chat.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ export class ChatPanel implements vscode.WebviewViewProvider {
252252
)
253253
.some((serverIsWorking) => serverIsWorking);
254254

255-
const localChatUsing = configuration.get("experimental.chat");
255+
const localChatUsing = configuration.get("local.chat.use");
256256
const supabase = getSuppabaseClient();
257257
const sesssion = await supabase.auth.getSession();
258258
const userLoggined = sesssion.data.session ? true : false;
@@ -329,7 +329,7 @@ export class ChatPanel implements vscode.WebviewViewProvider {
329329
}
330330

331331
private async handleEnableChat({ id }: { id: string }) {
332-
await configuration.set("experimental.chat", true);
332+
await configuration.set("local.chat.use", true);
333333
await this.postMessage({
334334
type: "e2w-response",
335335
id: id,

src/common/utils/configuration.ts

+6-5
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ const ConfigurationProperties = {
1111
"experimental.useGpu.osx.metal": {
1212
default: false,
1313
},
14-
"experimental.chat": {
14+
"local.chat.use": {
1515
default: false,
1616
},
1717
"experimental.useopentabs": {
@@ -54,7 +54,7 @@ interface ConfigurationPropertiesType
5454
"experimental.useGpu.osx.metal": {
5555
possibleValues: boolean;
5656
};
57-
"experimental.chat": {
57+
"local.chat.use": {
5858
possibleValues: boolean;
5959
};
6060
"experimental.useopentabs": {
@@ -69,15 +69,16 @@ interface ConfigurationPropertiesType
6969
homedir: {
7070
possibleValues: string;
7171
};
72+
"server.usePreRelease": {
73+
possibleValues: boolean;
74+
};
7275
"cloud.endpoint": {
7376
possibleValues: string;
7477
};
7578
"cloud.use": {
7679
possibleValues: boolean;
7780
};
78-
"server.usePreRelease": {
79-
possibleValues: boolean;
80-
};
81+
8182
"cloud.autocomplete.use": {
8283
possibleValues: boolean;
8384
};

src/extension.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ export async function activate(context: vscode.ExtensionContext) {
9595
component: "main",
9696
sendTelemetry: true,
9797
});
98-
} else if (configuration.get("experimental.chat")) {
98+
} else if (configuration.get("local.chat.use")) {
9999
Logger.info("Use local for chat.", {
100100
component: "main",
101101
sendTelemetry: true,
@@ -182,7 +182,7 @@ export async function activate(context: vscode.ExtensionContext) {
182182
event.affectsConfiguration("firecoder.cloud.use") ||
183183
event.affectsConfiguration("firecoder.cloud.chat.use") ||
184184
event.affectsConfiguration("firecoder.cloud.autocomplete.use") ||
185-
event.affectsConfiguration("firecoder.experimental.chat") ||
185+
event.affectsConfiguration("firecoder.local.chat.use") ||
186186
event.affectsConfiguration("firecoder.completion.manuallyMode") ||
187187
event.affectsConfiguration("firecoder.completion.autoMode") ||
188188
event.affectsConfiguration(

0 commit comments

Comments
 (0)