Merge pull request #53 from dimkauzh/dev

Update to docs

.github/workflows/mkdocs.yml

@@ -0,0 +1,32 @@
+name: MkDocs Deploy
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Check for changes in mkdocs.yml or docs folder
+        id: check_changes
+        run: |
+          if git diff --name-only ${{ github.event.before }} ${{ github.sha }} | grep -E 'mkdocs.yml|docs/'; then
+            echo "CHANGES=true" >> $GITHUB_ENV
+          else
+            echo "CHANGES=false" >> $GITHUB_ENV
+          fi
+
+      - name: Install dependencies (if needed)
+        if: env.CHANGES == 'true'
+        run: pip install mkdocs-material
+
+      - name: Deploy (if needed)
+        if: env.CHANGES == 'true'
+        run: mkdocs gh-deploy --force
+

README.md

@@ -9,6 +9,7 @@
 <a href="https://pypi.org/project/fusion-engine"><img alt="PyPI - Status" src="https://img.shields.io/pypi/status/fusion-engine?color=blue"></a>
 <a href="https://pypi.org/project/fusion-engine"><img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/fusion-engine?color=blue"></a>
 <a href="https://github.com/dimkauzh/fusion-engine/graphs/contributors"><img alt="GitHub contributors" src="https://img.shields.io/github/contributors/dimkauzh/fusion-engine?color=blue"></a>
+<a href="https://github.com/dimkauzh/fusion-engine"><img alt="Lines of code" src="https://tokei.rs/b1/github/dimkauzh/fusion-engine?category=lines"></a>
 </p>
 
 

docs/changelog/v4.md

@@ -27,5 +27,8 @@ hide:
   - [ ] Inheritance based
   - [ ] Build in loop
   - [ ] Make this optional and not the main way
+- [ ] Animation system
+  - [ ] Load images
+  - [ ] Play animation
 
 

docs/index.md

@@ -4,20 +4,52 @@ hide:
   - toc
 ---
 
-# Fusion Engine Documentation
+<p align="center">
+  <img src="https://github.com/dimkauzh/fusion-engine/assets/106883655/183ab172-2c3e-49b5-ba31-7c1ad63e564a" alt="logo">
+</p>
+
+<p align="center">
+<a href="https://pypi.org/project/fusion-engine"><img alt="PyPI" src="https://img.shields.io/pypi/v/fusion-engine?color=blue"></a>
+<a href="https://pypi.org/project/fusion-engine"><img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/fusion-engine?color=blue"></a>
+<a href="https://pypi.org/project/fusion-engine"><img alt="PyPI - License" src="https://img.shields.io/pypi/l/fusion-engine?color=blue"></a>
+<a href="https://pypi.org/project/fusion-engine"><img alt="PyPI - Status" src="https://img.shields.io/pypi/status/fusion-engine?color=blue"></a>
+<a href="https://pypi.org/project/fusion-engine"><img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/fusion-engine?color=blue"></a>
+<a href="https://github.com/dimkauzh/fusion-engine/graphs/contributors"><img alt="GitHub contributors" src="https://img.shields.io/github/contributors/dimkauzh/fusion-engine?color=blue"></a>
+</p>
+
+
+Fusion is a game engine for creating graphical applications using the Pygame library and the programming language Python. It provides a simple coding interface for creating windows,
+rendering graphics, and handling user input. It is and engine to create games fast and easy!
+
+## Repo
+Our Github repo [is here](https://github.com/dimkauzh/fusion-engine)
 
 ## 🗜️ Table of Contents
 Welcome to fusion engine documentation! We have seperated the documentation in some parts: main, api, wiki and tutorial. 
 Wiki is made if you need to know what a function does.
 Api is made if you need to know if a function exist and what arguments it takes,
 and in tutorials we made some tutorials for you to better understand fusion!
 
+## 💻 Setting up
+
+To install it run this:
+
+```bash
+  pip install fusion-engine
+```
+
+Then import:
+
+```python
+  import fusionengine as fusion
+```
+And your done!
+
+
 ## Todo list and changelog
  - [v4](changelog/v4.md)
  - [v3](changelog/v3.md)
 
-## v4
-
 ### Wiki
  - [Setting up](#setting-up)
  - [Wiki](v4/wiki/index.md)
@@ -30,7 +62,9 @@ and in tutorials we made some tutorials for you to better understand fusion!
 ### Tutorials
  - [Tutorials](v4/tutorials/index.md)
 
-## v3
+# v3
+## About
+The wiki, api and tutorials to the old v3 version of fusion, which is not being under development
 
 ### Wiki
  - [Setting up](#setting-up-v3)
@@ -45,22 +79,6 @@ and in tutorials we made some tutorials for you to better understand fusion!
  - [Tutorials](v3/tutorials/index.md)
 
 
-## 💻 Setting up
-
-To install it run this:
-
-```bash
-  pip install fusion-engine
-```
-
-Then import:
-
-```python
-  import fusionengine as fusion
-```
-And your done!
-
-
 ## 💻 Setting up v3
 
 To install it run this:

examples/example1.py

@@ -6,6 +6,6 @@
 
 @window.loop
 def loop():
-    window.set_fps(60)
     image.draw()
 
+