Skip to content

Commit

Permalink
Updated Readme text to reflect new packaging structure
Browse files Browse the repository at this point in the history
  • Loading branch information
Zuzu-Typ committed Oct 11, 2024
1 parent da65b76 commit 48fdaa1
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,15 @@ pip install PyGLM
```
And finally imported and used:
``` python
import glm
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\.

For more information, take a look at the [wiki](https://github.com/Zuzu-Typ/PyGLM/wiki)\.
#### License requirements
Please make sure to **include the license for GLM** in your project when you use PyGLM\!
Please make sure to **include COPYING** in your project when you use PyGLM\!
\(this is especially relevant for **binary distributions**, e\.g\. \*\.exe\)

You can do so by copying the ``` COPYING ``` file \(or it's contents\) to your project\.
Expand Down Expand Up @@ -102,7 +102,7 @@ I try adding them on a one\-by\-one basis\.

### Short example
``` Python
>>> import glm
>>> from PyGLM import glm
>>> v = glm.vec3()
>>> v.x = 7
>>> print(v.xxy)
Expand Down
6 changes: 3 additions & 3 deletions README.sb
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,15 @@ pip install PyGLM
\ code\
And finally imported and used:
\code python \
import glm
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.

For more information, take a look at the \url https://github.com/Zuzu-Typ/PyGLM/wiki \wiki\ url\.
\h4 \License requirements\ h4\
Please make sure to \b \include the license for GLM\ b\ in your project when you use PyGLM!
Please make sure to \b \include COPYING\ b\ in your project when you use PyGLM!
(this is especially relevant for \b \binary distributions\ b\, e.g. *.exe)

You can do so by copying the \code \COPYING\ code\ file (or it's contents) to your project.
Expand Down Expand Up @@ -100,7 +100,7 @@ I try adding them on a one-by-one basis.

\h3 \Short example\ h3\
\code Python \
>>> import glm
>>> from PyGLM import glm
>>> v = glm.vec3()
>>> v.x = 7
>>> print(v.xxy)
Expand Down

0 comments on commit 48fdaa1

Please sign in to comment.