Skip to content

Commit bf215ed

Browse files
docs(README): update important notes and correct development mode command
1 parent e96a63d commit bf215ed

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
>
33
> **vCode IDE is currently in alpha and is not ready for production use.** This is an early access version intended for testing and feedback. Expect frequent updates and potential breaking changes.
44
5+
# ⚠️ **Important Note**
6+
>
7+
> **This project was built in just 72 hours, so expect some rough edges.** There is currently a known issue with `node-pty` in production builds. For the best experience, please run the IDE locally by cloning the repository and using `npm run start`.
8+
59
# vCode IDE
610

711
![vCode Logo](src/assets/imgs/vcode_long.svg)
@@ -36,7 +40,7 @@ npm install
3640
### Development Mode
3741
To start the IDE in development mode with hot reloading:
3842
```sh
39-
npm run dev
43+
npm run start
4044
```
4145

4246
### Production Build

0 commit comments

Comments
 (0)