From 486880c056beaf2ba85e9c199a6cf98651d3ecf6 Mon Sep 17 00:00:00 2001 From: Zuzu-Typ Date: Sat, 12 Oct 2024 12:28:43 +0200 Subject: [PATCH] Updated Readme and manifest --- MANIFEST.in | 2 -- README.md | 7 ++++--- README.sb | 7 ++++--- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/MANIFEST.in b/MANIFEST.in index 87fdc7d..13deaf4 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -7,5 +7,3 @@ include VERSION include glm/py.typed recursive-include PyGLM-stubs * recursive-include PyGLM_lib * -recursive-exclude PyGLM_lib/glm/test * -recursive-exclude PyGLM_lib/glm/doc * diff --git a/README.md b/README.md index bc54c96..10b80f1 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,8 @@ from PyGLM import glm ``` ### Using PyGLM PyGLM's syntax is very similar to the original GLM's syntax\. -There is no need to import anything but **glm**, as it already contains the entire package\. +The module \`glm\` contains all of PyGLM's types and functions\. +[Typing stubs](https://github.com/esoma/pyglm-typing) by @esoma are available in the \`glm\_typing\` module\. For more information, take a look at the [wiki](https://github.com/Zuzu-Typ/PyGLM/wiki)\. #### License requirements @@ -121,12 +122,12 @@ vec4( 9, 9, 9, 9 ) ``` ### PyGLM in action -Wanna see what PyGLM can do? +Want to see what PyGLM can do? Take a look at the [examples](https://github.com/Zuzu-Typ/LearnOpenGL-Python) from the popular LearnOpenGL tutorials by Joey De Vries running in Python using PyGLM\. ![LearnOpenGL](https://raw.githubusercontent.com/Zuzu-Typ/PyGLM/master/LearnOpenGL.png) ### Speed comparison to numpy -The following is the output generated by [test/PyGLM vs Numpy\.py](https://github.com/Zuzu-Typ/PyGLM/blob/master/test/PyGLM%20vs%20NumPy.py) +The following is the output generated by [test/PyGLM vs Numpy\.py](https://github.com/Zuzu-Typ/PyGLM/blob/master/test/PyGLM_vs_NumPy.py) ``` Evaluating performance of PyGLM compared to NumPy. diff --git a/README.sb b/README.sb index 66e1cee..f7d6cde 100644 --- a/README.sb +++ b/README.sb @@ -31,7 +31,8 @@ from PyGLM import glm \ code\ \h3 \Using PyGLM\ h3\ PyGLM's syntax is very similar to the original GLM's syntax. -There is no need to import anything but \b\glm\b\, as it already contains the entire package. +The module `glm` contains all of PyGLM's types and functions. +\url https://github.com/esoma/pyglm-typing \Typing stubs\ url\ by \raw \@esoma\ raw\ are available in the `glm_typing` module. For more information, take a look at the \url https://github.com/Zuzu-Typ/PyGLM/wiki \wiki\ url\. \h4 \License requirements\ h4\ @@ -119,12 +120,12 @@ vec4( 9, 9, 9, 9 ) \ code\ \h3\PyGLM in action\h3\ -Wanna see what PyGLM can do? +Want to see what PyGLM can do? Take a look at the \url https://github.com/Zuzu-Typ/LearnOpenGL-Python\examples\ url\ from the popular LearnOpenGL tutorials by Joey De Vries running in Python using PyGLM. \raw\![LearnOpenGL](https://raw.githubusercontent.com/Zuzu-Typ/PyGLM/master/LearnOpenGL.png)\raw\ \h3 \Speed comparison to numpy\ h3\ -The following is the output generated by \url https://github.com/Zuzu-Typ/PyGLM/blob/master/test/PyGLM%20vs%20NumPy.py \test/PyGLM vs Numpy.py\ url\ +The following is the output generated by \url https://github.com/Zuzu-Typ/PyGLM/blob/master/test/PyGLM_vs_NumPy.py \test/PyGLM vs Numpy.py\ url\ \code \ Evaluating performance of PyGLM compared to NumPy.