Skip to content

Commit e451134

Browse files
committed
README tweaks
1 parent d624aae commit e451134

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
PyWavefront
55
===========
66

7-
PyWavefront reads Wavefront 3D object files (`something.obj` and `something.mtl`)
8-
and generates interleaved vertex data for each material ready for rendering.
7+
PyWavefront reads Wavefront 3D object files (`something.obj`, `something.obj.gz`
8+
and `something.mtl`) and generates interleaved vertex data for each material ready for rendering.
99
Python 2.7.x or 3.6+ is supported. A simple (optional) visualization module is also
1010
provided for rendering the object(s). The interleaved data can also be used by
1111
more modern renderers thought VBOs or VAOs.
@@ -15,7 +15,8 @@ been implemented. Positions, texture coordinates, normals, vertex color and mate
1515
We currently don't support parameter space vertices, line elements or smoothing groups.
1616
Create an issue or pull request on github if needed features are missing.
1717

18-
The package is on pypi or can be cloned on [github](https://github.com/greenmoss/PyWavefront).
18+
The package is on [pypi](https://pypi.org/project/PyWavefront/)
19+
or can be cloned on [github](https://github.com/greenmoss/PyWavefront).
1920

2021
```
2122
pip install PyWavefront
@@ -63,9 +64,10 @@ When ``cache=True`` the interleaved vertex data is written
6364
as floats to a ``.bin`` file after the file is loaded. A json
6465
file is also generated describing the contents of the binary file.
6566
The binary file will be loaded the next time we attept to load
66-
the obj file reducing the loading time greatly.
67+
the obj file reducing the loading time significantly.
6768

68-
Tests have shown loading time reduction by 10x to 30x.
69+
Tests have shown loading time reduction by 10 to 100 times
70+
depending on the size and structure of the original obj file.
6971

7072
Loading ``myfile.obj`` will generate the following files in the
7173
same directory.
@@ -101,7 +103,7 @@ Json file example:
101103
}
102104
```
103105

104-
These files will not be recreated until you delete them.
106+
These files will **not be recreated until you delete them**.
105107
The bin file is also compessed with gzip to greatly reduce size.
106108

107109
## Visualization

0 commit comments

Comments
 (0)