uc-dev 1.0.0-beta.1 → 1.0.0-beta.3

package/README.md

@@ -1,53 +1,146 @@
 :Shree Ganeshay Namah:<br />
-# uc-dev
+# 🚀 uc-dev
 
 
-> CLI toolkit for UC project development
-
-`uc-dev` is a command-line utility that helps manage UC-based projects by automating setup and designer build workflows.
-
-⚠ Status: **Beta**
+CLI Tool for building and scaffolding UC-based Electron projects
 
+`uc-dev` helps you:
+* Build designer files
+* Configure project structure
+* Generate Electron startup files
+* Generate ucconfig.js
+* Generate TypeScript config
+* Quickly scaffold a ready-to-run UC project
 ---
-
-## Installation
-
-### Global install (recommended)
-
+📦 Installation
 ```bash
 npm install -g uc-dev
 ```
-### Local install
+Or use locally:
 ```bash
-npm install uc-dev
+npm install --save-dev uc-dev
 ```
-Commands
-build
+---
+## 🛠 Commands
+
+1️⃣ `uc-dev build`<br>
+
+Builds designer files only.
 
-Generate designer files for the project.
 ```bash
 uc-dev build
 ```
-- this generate designer for all usercontrols and templates.
-- also generate a single resource file that hold project's resurces (all used contents in string format except source code) that make easy for bundling.
-- each resource will assigned uniqueid to access.
 
-Use this command whenever designer files change.
+✔ Compiles designer<br>
+✔ Prepares runtime-ready files
+
+## 2️⃣ uc-dev setup
+
+Launches interactive setup menu.
 
----
-`setup`<br>
-Initializes a project for development.
 ```bash
 uc-dev setup
 ```
-What it does:
-- Installs required dependencies (also done before build)
-- Creates necessary directories
-- Configures project paths
-- Prepares development environment
-- Run once when starting a new project.
+📋 MAIN MENU
+```bash
+--M A I N - M E N U-----------
+  P = Parameters
+  B = Build Designers
+  G = Generate
+  Q = Quit
+What to Do Now ? (q):
+```
+### 🔹 P = Parameters 
+Configure project directories and related settings:
+src directory
+out directory
+resource directory
+designer directory
+other setup-related paths
+These values are later used when generating files.
+
+### 🔹 B = Build Designers
+
+Shortcut for:  `uc-dev build`
+### 🔹 G = Generate
+Opens Generate Submenu
+```bash
+--G E N E R A T E-------------
+  E = Electron Stuffs
+  S = Sample Style1
+  U = 'ucconfig.js' file
+  V = '.vscode/settings.json' file
+  T = 'tsconfig.json' for project
+  A = Do All Above
+  Q = Quit
+What to Do Now ? (q):
+  ```
+### 🔹 E = Electron Stuffs
+Generates starter Electron files:
+- main process file
+- preload file
+- renderer starter
+- basic window creation
+- Quick start structure for Electron project.
+
+### 🔹 S = Sample Style1
+
+Generates:
+Sample UserControl
+Sample Template
+Demo structure for understanding UC pattern
+
+### 🔹 U = ucconfig.js
+
+Generates ucconfig.js using values collected from Parameters section.
+
+### 🔹 V = .vscode/settings.json
+
+Generates VSCode settings for:
+Better path resolution
+Improved project visibility
+Cleaner TypeScript experience
+
+### 🔹 T = tsconfig.json
+
+Generates recommended TypeScript configuration.
+Optional — only if project uses TypeScript.
+
+### 🔹 A = Do All Above
+
+Runs everything:
+- Electron Stuffs
+- Sample
+- ucconfig.js
+- VSCode settings
+- tsconfig
+- Build designers
+
+👉 Creates a ready-to-run project structure
+
+🧠 Typical Workflow
+First time project setup:
+uc-dev setup
 
----
+Go to P → configure parameters
+
+Go to G → press A
+
+Done ✅
+
+Regular development build:
+```bash
+uc-dev build
+```
+📁 Project Structure (For Default Config)
+```
+src/
+  designerFiles/
+    Resources.ts
+out/
+ucconfig.js
+tsconfig.json
+```
 
 Typical Workflow
 ```bash