Skip to content

Commit e7a9787

Browse files
committed
Enhanced README.md document with detailed features and project structure
1 parent d502b19 commit e7a9787

File tree

1 file changed

+34
-19
lines changed

1 file changed

+34
-19
lines changed

README.md

Lines changed: 34 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,23 @@ This project is a web-based visual scripting environment that allows users to cr
99
## Features
1010

1111
- Node-based visual programming interface
12-
- Support for various node types including control flow, data manipulation, functions, and more
13-
- Real-time code generation
14-
- Ability to run scripts with or without debugging
12+
- Support for various node types:
13+
- Control flow (If, Switch, Loops)
14+
- Data manipulation (Variables, Math Operations)
15+
- Array and Object operations
16+
- HTTP Requests
17+
- JSON handling (Parse, Stringify)
18+
- Base64 encoding/decoding
19+
- Real-time code generation with customizable settings
20+
- Ability to run scripts with debugging support
1521
- Undo/Redo functionality
16-
- Zoom and pan canvas controls
17-
- Save and load projects
18-
- Export projects as JSON or JavaScript
19-
- Dark and light theme options
20-
- Customizable grid and minimap
21-
- Example projects included
22+
- Canvas controls (zoom, pan)
23+
- Project management (save, load)
24+
- Export options (JSON, JavaScript, Image)
25+
- Theme customization (dark/light)
26+
- Grid and minimap visualization
27+
- Graph inspector panel
28+
- Predefined example projects
2229

2330
## Installation
2431

@@ -46,23 +53,31 @@ This project is a web-based visual scripting environment that allows users to cr
4653

4754
## Usage
4855

49-
1. Use the menu bar to create a new project, open an existing one, or load an example.
50-
2. Right-click on the canvas to open the context menu and add nodes.
51-
3. Connect nodes by clicking and dragging from one port to another.
52-
4. Use the property panel on the right to adjust node properties.
53-
5. Run your script using the "Run" menu options.
54-
6. Generate code using the "Generate code" option in the "Run" menu.
55-
7. Export your project as JSON or JavaScript using the "Export" menu.
56+
1. Use the menu bar to create a new project or load an example
57+
2. Add nodes by right-clicking on the canvas
58+
3. Connect nodes by dragging from one port to another
59+
4. Configure node properties using the Graph Inspector panel
60+
5. Use the Settings tab to customize:
61+
- Theme preferences
62+
- Canvas display options
63+
- Code generation settings
64+
6. Generate and run your script using the Run menu
65+
7. Export your project in various formats
5666

5767
## Project Structure
5868

5969
- `src/App.js`: Main application component
6070
- `src/VisualScripting.js`: Core visual scripting component
6171
- `src/CodeGenerator.js`: Handles code generation from nodes
62-
- `src/engine/Camera.js`: Manages canvas zoom and pan
63-
- `src/engine/Renderer.js`: Handles rendering of nodes and connections
6472
- `src/nodeDefinitions.js`: Defines available node types
65-
- `src/components/`: Contains React components for UI elements
73+
- `src/engine/`: Core engine components
74+
- `Camera.js`: Manages canvas zoom and pan
75+
- `Renderer.js`: Handles rendering of nodes and connections
76+
- `Node.js`: Node class implementation
77+
- `src/components/`: React components for UI elements
78+
- `GraphInspector.js`: Node properties panel
79+
- `MenuBar.js`: Application menu
80+
- `SettingsTab.js`: Configuration interface
6681
- `src/examples.js`: Predefined example projects
6782

6883
## Contributing

0 commit comments

Comments
 (0)