tinyecs 0.3.3__tar.gz → 0.3.5__tar.gz

{tinyecs-0.3.3/src/tinyecs.egg-info → tinyecs-0.3.5}/PKG-INFO

@@ -1,32 +1,34 @@
 Metadata-Version: 2.4
 Name: tinyecs
-Version: 0.3.3
+Version: 0.3.5
 Summary: The teeniest, tiniest ECS system
 Author-email: Michael Lamertz <michael.lamertz@gmail.com>
 License-Expression: MIT
 Project-URL: homepage, https://github.com/dickerdackel/tinyecs
 Project-URL: bugtracker, https://github.com/DickerDackel/tinyecs/issues
+Project-URL: docs, https://tinyecs.readthedocs.io/
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
 Classifier: Topic :: Games/Entertainment
 Classifier: Topic :: Software Development :: Libraries :: pygame
-Description-Content-Type: text/markdown
+Description-Content-Type: text/x-rst
 License-File: LICENSE
 Requires-Dist: pgcooldown
 Dynamic: license-file
 
-# tinyecs - The teeniest, tiniest ECS for python
+Introduction
+############
 
 ECS stands for Entity Component System, and it is a programming paradigm that
 differs from the well known OO.
 
-During my research I stumbled over
+During my research I stumbled over `this article`_ and after reading part 2 and
+3, I decided to implement an ECS myself, well aware that `esper` is a solid
+and long existing implementation, but I wanted to see how to implement it
+myself.
 
-[this article](https://web.archive.org/web/20250408195932/https://t-machine.org/index.php/2007/09/03/entity-systems-are-the-future-of-mmog-development-part-1/)
+.. _this article: https://web.archive.org/web/20250408195932/https://t-machine.org/index.php/2007/09/03/entity-systems-are-the-future-of-mmog-development-part-1/
 
-and after reading part 2 and 3, I decided to implement an ECS myself, well
-aware that `esper` is a solid and long existing implementation, but I wanted
-to see how to implement it myself.
 
 I'm not trying to sell you an ECS by explaining the problems of multiple
 inheritance in game programming.  There are articles out there that do this in
@@ -36,30 +38,40 @@ bouncing sprites using pygame-ce.  But tinyecs is platform agnostic, you can
 use it with whatever library you like.
 
 
-## Installation
+Installation
+============
 
 tinyecs is available on pip and can be installed by::
 
     pip install tinyecs
 
-The project is maintained and hosted on github at
-https://github.com/dickerdackel/tinyecs, where you also can find the wheels
-for a local install, or install it directly from the cloned repo.
+The project is maintained and hosted on `github`_, where you also can find the
+wheels for a local install, or install it directly from the cloned repo.
 
-```console
-git clone https://github.com/dickerdackel/tinyecs
-cd tinyecs
-python3 -m venv --prompt tinyecs .venv
-.venv/bin/activate
-# or .venv/Scripts/activate.bat on windows
-pip install .
-```
+.. _github: https://github.com/dickerdackel/tinyecs
 
-## Support / Contributing
+.. code-block::
 
-Issues can be opened on `Github`_
+    git clone https://github.com/dickerdackel/tinyecs
+    cd tinyecs
+    python3 -m venv --prompt tinyecs .venv
+    .venv/bin/activate
+    # or .venv/Scripts/activate.bat on windows
+    pip install .
 
-.. _Github: https://github.com/dickerdackel/tinyecs/issues
+Documentation
+=============
+
+The project home and main documentation is on `Read the Docs`_.
+
+.. _Read the Docs: https://tinyecs.readthedocs.io/
+
+Support / Contributing
+======================
+
+Issues can be opened on `github issues`_
+
+.. _github issues: https://github.com/dickerdackel/tinyecs/issues
 
 Please respect, that I don't want any contributions done with the assistance
 of AI.  This is a hobby project with focus on the craft of programming.  I
@@ -70,7 +82,8 @@ provided solutions were often besides the point or plain wrong.
 I have no possibility to enforce that request, the simple fact that I ask for
 it should be sufficient.
 
-## License
+License
+=======
 
 This software is provided under the MIT license.
 

tinyecs-0.3.3/docs/source/introduction.rst → tinyecs-0.3.5/README.rst

@@ -32,6 +32,8 @@ wheels for a local install, or install it directly from the cloned repo.
 
 .. _github: https://github.com/dickerdackel/tinyecs
 
+.. code-block::
+
     git clone https://github.com/dickerdackel/tinyecs
     cd tinyecs
     python3 -m venv --prompt tinyecs .venv
@@ -39,12 +41,19 @@ wheels for a local install, or install it directly from the cloned repo.
     # or .venv/Scripts/activate.bat on windows
     pip install .
 
+Documentation
+=============
+
+The project home and main documentation is on `Read the Docs`_.
+
+.. _Read the Docs: https://tinyecs.readthedocs.io/
+
 Support / Contributing
 ======================
 
-Issues can be opened on `Github`_
+Issues can be opened on `github issues`_
 
-.. _Github: https://github.com/dickerdackel/tinyecs/issues
+.. _github issues: https://github.com/dickerdackel/tinyecs/issues
 
 Please respect, that I don't want any contributions done with the assistance
 of AI.  This is a hobby project with focus on the craft of programming.  I

{tinyecs-0.3.3 → tinyecs-0.3.5}/pyproject.toml

@@ -1,8 +1,8 @@
 [project]
 name = "tinyecs"
 description = "The teeniest, tiniest ECS system"
-version = "0.3.3"
-readme = "README.md"
+version = "0.3.5"
+readme = "README.rst"
 
 authors = [
     { name="Michael Lamertz", email="michael.lamertz@gmail.com" }
@@ -30,6 +30,7 @@ tinyecs-demo = 'tinyecs.demo:main'
 [project.urls]
 homepage = "https://github.com/dickerdackel/tinyecs"
 bugtracker = "https://github.com/DickerDackel/tinyecs/issues"
+docs = "https://tinyecs.readthedocs.io/"
 
 [build-system]
 requires = ["setuptools"]