Merge pull request #2 from Miras3210/Mira

Project Description update

Author: Miras3210

README.md

@@ -5,26 +5,29 @@ _A lightweight frontend Python project_
 ## Information
 
 This project uses [Pyodide](https://pyodide.org) to run Python directly in the browser using WebAssembly (WASM).  
-No JavaScript is required — the frontend is written entirely in Python and HTML/CSS.
+Almost no JavaScript is required — the frontend is written entirely in Python and HTML/CSS.
 
 ## Current Project Structure
 
 ```
 project/
-│   .gitignore
-│   .pre-commit-config.yaml
-│   LICENSE.txt
-│   pyproject.toml
-│   README.md
-│   template_README.md
-├───.github/
-│   └───workflows/
-│           lint.yaml
-├───samples/
-│       Pipfile
-│       pyproject.toml
-└───src/
-        main.py
+│  .gitignore
+│  build.py
+│  README.md
+│
+├─ .github/workflows/
+│    lint.yaml
+│
+├─ public/
+│    index.html
+│    templates/apptemplate.html
+│
+├─ samples/
+│    Pipfile
+│
+└─ src/
+    hello.py
+    main.py
 ```
 
 ## Dev Code Checks
@@ -59,15 +62,15 @@ pre-commit run check-toml --all-files
 ```py
 class ClassName:
     '''
-    Handles user input and validation.
+    Handle user input and validation.
     @author Mira
     '''
     ...
 
 # Short function description - Author
 def do_something():
     '''
-    Performs a single-step operation.
+    Perform a single-step operation.
     @author Mira
     '''
     ...

public/templates/apptemplate.html

@@ -42,7 +42,7 @@
     <div class="console">
       Image editor v2.1 $ ping<br>
       pong!<br>
-      Image editor v2.1 $ 
+      Image editor v2.1 $
     </div>
   </body>
 </html>

pyproject.toml

@@ -1,10 +1,15 @@
 [project]
 # This section contains metadata about your project.
 # Don't forget to change the name, description, and authors to match your project!
-name = "code-jam-template"
-description = "Add your description here"
+name = "command-line-image-editor"
+description = "A simple yet interesting image editor."
 authors = [
-    { name = "Your Name" }
+    { name = "Mira"},
+    { name = "Julien"},
+    { name = "Jont"},
+    { name = "Philip"},
+    { name = "Ricky P"},
+    { name = "Mark"}
 ]
 version = "0.1.0"
 readme = "README.md"