Skip to content

GETTING_STARTED.md

Latest commit

 

History

History
149 lines (101 loc) · 2.94 KB

GETTING_STARTED.md

File metadata and controls

149 lines (101 loc) · 2.94 KB

🎉 Som DVPS - Successfully Installed!

✅ Installation Complete

All dependencies have been successfully installed. You're now ready to build and run Som DVPS!

🚀 Next Steps - Running Som DVPS

Step 1: Build/Watch Mode (Terminal 1)

Open a terminal and run:

cd c:\code\vscode
npm run watch

What this does:

  • Compiles TypeScript to JavaScript
  • Watches for file changes and auto-recompiles
  • Keep this terminal running!

You'll see output like:

[watch-client] Starting compilation...
[watch-extensions] Starting compilation...

Wait until you see: Compilation complete. Watching for file changes.

Step 2: Launch Som DVPS (Terminal 2)

Open a NEW terminal (keep the first one running) and run:

cd c:\code\vscode
.\scripts\code.bat

Your custom Som DVPS editor will launch! 🚀

🎨 Customizing Som DVPS

Change Product Name & Branding

Edit product.json:

{
  "nameShort": "Som DVPS",
  "nameLong": "Som DVPS Code Editor",
  "applicationName": "som-dvps",
  "dataFolderName": ".som-dvps",
  "win32MutexName": "somdvps",
  "licenseName": "MIT",
  "licenseUrl": "https://github.com/yourusername/som-dvps/blob/main/LICENSE.txt",
  ...
}

Change Application Icon

Replace these files in resources/win32/:

  • code.ico - Main application icon
  • inno-big.bmp - Installer banner
  • inno-small.bmp - Installer icon

Customize Welcome Screen

Edit src/vs/workbench/contrib/welcome/page/browser/welcomePage.ts

Add Custom Extensions

Place your extensions in extensions/ folder

📦 Building Distributable Package

When you're ready to create an installer:

npm run gulp vscode-win32-x64

This creates a distributable package in .build/win32-x64/

🛠️ Development Commands

Command Description
npm run watch Watch mode (auto-recompile)
npm run compile One-time compilation
.\scripts\code.bat Launch Som DVPS
npm test Run tests
npm run eslint Lint code
npm run gulp hygiene Check code hygiene

🐛 Troubleshooting

"Module not found" errors

npm run compile

Changes not reflecting

  1. Stop npm run watch (Ctrl+C)
  2. Run npm run compile
  3. Restart npm run watch
  4. Relaunch Som DVPS

Clean rebuild

npm run gulp clean
npm run compile

📚 Useful Resources

🎯 What's Next?

  1. Customize branding in product.json
  2. Add your features in src/vs/workbench/
  3. Create custom themes in extensions/theme-*/
  4. Build and distribute your custom editor!

Congratulations on setting up Som DVPS! 🎊

Your custom VS Code fork is ready for development!