Merge pull request #67 from fusionengine-org/dev

V4.3.0

.github/workflows/ci_check.yml

@@ -1,6 +1,3 @@
-# This workflow will install Python dependencies, run tests and lint with a single version of Python
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
-
 name: CI Check
 
 on:
@@ -17,7 +14,7 @@ permissions:
   contents: read
 
 jobs:
-  build:
+  install:
 
     runs-on: ubuntu-latest
 
@@ -32,13 +29,14 @@ jobs:
       run: python -m pip install --upgrade pip
 
     - name: Install packages
-      run: python -m pip install setuptools sdist wheel build
+      run: python -m pip install --user pdm
 
-    - name: Build module
-      run: python setup.py ci_check
+    - name: Install module (pdm)
+      run: python -m pdm install
 
+
+  build:
 
-  install:
     runs-on: ubuntu-latest
 
     steps:
@@ -50,7 +48,9 @@ jobs:
 
     - name: Update PIP
       run: python -m pip install --upgrade pip
-
-    - name: Install module
-      run: python setup.py install
 
+    - name: Install packages
+      run: python -m pip install --user pdm
+
+    - name: Build module (pdm)
+      run: python -m pdm build

.github/workflows/lint.yml

@@ -0,0 +1,10 @@
+name: Lint
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: psf/black@stable

CONTRIBUTING.md

@@ -1,10 +1,17 @@
 # Contributing
 We are happy and welcome if you want to contribute to fusion engine. But please consider a few details before continuing:
 - Branch: Please when working on your fork, work in the dev branch, because we only will accept commits to the dev branch. It will later be released with the next version of fusion.
-- Explain: Please explain why this should be considered and merged. 
+- Explain: Please explain why this should be considered and merged. That will make our life easier.
 - Test: Please test your code before even opening a new pull request. 
 - Documentation: Please, if your adding something new, like a feature, please document everything. 
+- Format: Please, run black for formatting of the code.
 
 ## Not following these rules
 If we see a pull request that doesn't follow these rules, we will tell you that, and close the pull request. 
 We allow you to re-open a new pull request, but we expect you to have your code fixed.
+
+## Some technologies we are using
+- PDM: We are using pdm for our main interaction with the library.
+- pyproject.toml: Pythons way for setting up a project. A replacement for setup.py
+- pygame-ce, pygame_gui and pymunk: We are using all three of these libraries to develop fusion engine.
+- black: We are using black to format code

README.md

@@ -52,7 +52,7 @@ if you want to install the package from source and get the latest changes then y
 ```bash
  git clone https://github.com/dimkauzh/fusion-engine.git
  cd fusion-engine
- python setup.py install
+ pip install .
 ```
 
 ### Run example
@@ -82,20 +82,14 @@ For different examples, you change the number to the number of the example file
 
 ## 👥 Community
 
-Our community is just growing, so if you want to help us with the project,
-it will be very helpful!
 We have a discord server at this [link](<https://discord.gg/Smg3CK4ZMc>).
-Need to contact us? Just DM the Owner or CEO in discord and we will try to react as fast as possible
-
-### ❤️ Special thanks to these people
+Need to contact us? Just #dimkauzh in discord and he will try to react as fast as possible
 
-- Zenthm (Contributing)
-- XCarCedo (Contributing)
-- nmsderp (Contributing)
-- Techsplosion (Contributor)
-- FBS_Gamer (Discord server)
-
-And our community of course!
+## Contributing
+Our community is just growing, so if you want to help us with the project,
+it will be very helpful! We are welcome to all people who want to contribute, but you do need to follow the [contribution rules](CONTRIBUTING.md)
+Special thanks to all the contributors, they made the project even better!
+And thanks to our community of course!
 
 ## Tutorials
 Are you exited to start with fusion engine but you dont know where to start? Then maybe its worth looking though one of our tutorials! We tried to make them as simple as possible but still very informative. You can find them [here](<https://docs.fusion-engine.tech/>)