]> Skullheadx's Git Forge - Electric-Dipoles.git/commitdiff
update readme
authorSkullheadx <admonty1@gmail.com>
Wed, 4 Sep 2024 19:08:33 +0000 (15:08 -0400)
committerSkullheadx <admonty1@gmail.com>
Wed, 4 Sep 2024 19:08:33 +0000 (15:08 -0400)
.gitignore
readme.md

index 2d0653a28545851b2ddeaf9725d24ff05ac90096..854fb5e05e014314805a91e5a0651510e3b45abc 100644 (file)
@@ -160,3 +160,4 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 .idea/
 
+.DS_Store
index 76e677aa32c3dfb3097964248f8f4decc4ef3b54..9dee38f2557898b6c2424807c65d274ebe14f693 100644 (file)
--- a/readme.md
+++ b/readme.md
@@ -2,16 +2,19 @@
 
 ![image of simulation](simulation.png)
 
+## Description
+- Accurately simulates the electric field strength and visualizes real time.
+
 ## Dependencies
 (You might have to uninstall pygame if it is already installed)
 
 ```pip install pygame-ce library```
 
 ## How to Run
-run main.py
+- Run main.py
 
 ## Controls
-drag particles around to move them.
+- Drag particles around to move them.
 
 ## Extra
-add more particles to particles list in main.py for more fun.
+- Add more particles to particles list in main.py for more fun.