p3nGu1nZz commited on
Commit
29ec31e
·
1 Parent(s): b27f287

updated readme

Browse files
Files changed (1) hide show
  1. README.md +40 -1
README.md CHANGED
@@ -24,9 +24,10 @@ The Plasma Arc Project aims to develop a sophisticated and efficient plasma arc
24
  - Realistic visualizations using WebGPU
25
  - Modular and extendable codebase
26
  - User-friendly interface
 
27
 
28
  ## WebGPU Integration
29
- WebGPU is utilized for its advanced graphics and compute capabilities, enabling our simulation to run efficiently on a wide range of devices. By offloading heavy computations to the GPU, we achieve smoother and more responsive visualizations.
30
 
31
  ## Installation
32
 
@@ -38,3 +39,41 @@ WebGPU is utilized for its advanced graphics and compute capabilities, enabling
38
  ```bash
39
  git clone https://github.com/yourusername/plasma-arc-project.git
40
  cd plasma-arc-project
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
24
  - Realistic visualizations using WebGPU
25
  - Modular and extendable codebase
26
  - User-friendly interface
27
+ - Fast iteration with modular WebGPU components
28
 
29
  ## WebGPU Integration
30
+ WebGPU is utilized for its advanced graphics and compute capabilities, enabling our simulation to run efficiently on a wide range of devices. By offloading heavy computations to the GPU, we achieve smoother and more responsive visualizations. The modular design aligns with industry standards like Unreal Engine 5, ensuring familiarity and ease of use for developers.
31
 
32
  ## Installation
33
 
 
39
  ```bash
40
  git clone https://github.com/yourusername/plasma-arc-project.git
41
  cd plasma-arc-project
42
+ ```
43
+
44
+ ### Running the Simulation
45
+ 1. Open `index.html` in your WebGPU-compatible browser.
46
+ 2. Modify the configurations as needed in the `config` object.
47
+ 3. Refresh the browser to see your changes instantly with the fast iterative development.
48
+
49
+ ## Modular Components
50
+ The project is structured using modular components for WebGPU, ensuring a clean and scalable codebase:
51
+ - **wgpu-device.js**: Handles WebGPU device initialization.
52
+ - **wgpu-state.js**: Manages the application state.
53
+ - **wgpu-utility.js**: Utility functions for texture and other operations.
54
+ - **wgpu-pipeline.js**: Manages the creation of WebGPU pipelines.
55
+ - **wgpu-shader.js**: Fetches and compiles shader codes.
56
+ - **wgpu-texture.js**: Manages vertex data and textures.
57
+ - **wgpu-buffer.js**: Handles buffer creation and management.
58
+ - **wgpu-timing.js**: Manages timing and game loop properties.
59
+
60
+ ## Contributing
61
+ We welcome contributions! Please submit issues or pull requests to help improve the project. Make sure to follow the coding standards and write tests for new features.
62
+
63
+ ## License
64
+ This project is licensed under the MIT License.
65
+
66
+ ## Citation
67
+ If you use this project in your research, please cite it as follows:
68
+
69
+ ```bibtex
70
+ @misc{plasma_arc,
71
+ author = {K. Rawson},
72
+ title = {Plasma Arc Project},
73
+ year = {2024},
74
+ publisher = {GitHub},
75
+ journal = {GitHub repository},
76
+ howpublished = {\url{https://github.com/yourusername/plasma-arc-project}},
77
+ email = {[email protected]}
78
+ }
79
+ ```