@mlightcad/cad-simple-viewer 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 mlight-lee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,26 @@
+# CAD Simple Viewer
+
+This package provides the **high-performance** core components of a CAD viewer such as document management, command handling, and collaboration between the UI and rendering engines. It's designed for optimal performance when handling large CAD files.
+
+This module doesn't depend on any UI framework and doesn't provide any UI except canvas. If you want to integrate a high-performance CAD viewer into a web application with your own UI, this module is the correct choice.
+
+## Key Features
+- Document management optimized for large files
+- Efficient command stack and undo/redo operations
+- Optimized integration with rendering engines
+- Performance-focused settings and context management
+- Framework-agnostic design for maximum flexibility
+
+
+## Directory Structure (partial)
+- `src/app/` – Document/context management, settings
+- `src/command/` – Command implementations (open, zoom, select, etc.)
+- `src/editor/` – Command stack, input handling, global functions
+- `src/view/` – Layout and scene management
+- `src/util/` – Utilities
+
+## Usage
+Entry point: `src/app/index.ts`. Used by the main application to manage documents and commands.
+
+## Role in MLightCAD
+This package acts as the core logic layer, connecting the frontend UI with the rendering engines and managing all document-related operations.