Skip to content

Commit 73d1c65

Browse files
committed
README typos
1 parent db4c1dc commit 73d1c65

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

README.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@
77

88
</div>
99

10-
PyWavefront
11-
===========
10+
# PyWavefront
1211

1312
PyWavefront reads Wavefront 3D object files (`something.obj`, `something.obj.gz`
1413
and `something.mtl`) and generates interleaved vertex data for each material ready for rendering.
@@ -28,13 +27,15 @@ been implemented:
2827
* Normals
2928
* Vertex Color
3029
* Material parsing
30+
* Texture and texture parameters
3131

32-
We currently don't support parameter space vertices, line elements or smoothing groups. Create an issue or pull request on github if needed features are missing.
32+
We currently don't support parameter space vertices, line elements or smoothing groups.
33+
Create an issue or pull request on github if needed features are missing.
3334

3435
The package is on [pypi](https://pypi.org/project/PyWavefront/)
3536
or can be cloned on [github](https://github.com/pywavefront/PyWavefront).
3637

37-
```
38+
```bash
3839
pip install pywavefront
3940
```
4041

@@ -82,7 +83,7 @@ for name, material in scene.materials.items():
8283
When ``cache=True`` the interleaved vertex data is written
8384
as floats to a ``.bin`` file after the file is loaded. A json
8485
file is also generated describing the contents of the binary file.
85-
The binary file will be loaded the next time we attept to load
86+
The binary file will be loaded the next time we attempt to load
8687
the obj file reducing the loading time significantly.
8788

8889
Tests have shown loading time reduction by 10 to 100 times
@@ -91,7 +92,7 @@ depending on the size and structure of the original obj file.
9192
Loading ``myfile.obj`` will generate the following files in the
9293
same directory.
9394

94-
```
95+
```txt
9596
myfile.obj.bin
9697
myfile.obj.json
9798
```
@@ -123,12 +124,13 @@ Json file example:
123124
```
124125

125126
These files will **not be recreated until you delete them**.
126-
The bin file is also compessed with gzip to greatly reduce size.
127+
The bin file is also compressed with gzip to greatly reduce size.
127128

128129
## Visualization
129130

130131
[Pyglet](http://www.pyglet.org/) is required to use the visualization module.
131-
```
132+
133+
```bash
132134
pip install pyglet
133135
```
134136

@@ -162,13 +164,15 @@ pywavefront.configure_logging(
162164
### Examples
163165

164166
The [examples](https://github.com/pywavefront/PyWavefront/tree/master/examples)
165-
directory contains some basic examples using the `visualization` module and further instructions on how to run them.
167+
directory contains some basic examples using the `visualization` module and further
168+
instructions on how to run them.
166169

167170
### Generating a Wavefront file with Blender
168171

169172
The following presumes you are using [Blender](http://www.blender.org/) to generate your mesh:
170173

171-
* Using Blender, create a mesh with a UV-mapped texture. The UV-mapping is important! If it is working properly, you will see the texture applied within Blender's 3d view.
174+
* Using Blender, create a mesh with a UV-mapped texture. The UV-mapping is important!
175+
If it is working properly, you will see the texture applied within Blender's 3d view.
172176
* Export the mesh from Blender using the Wavefront format, including normals.
173177
* Reference your `*.obj` file as in the pywavefront example above.
174178

@@ -186,7 +190,7 @@ pip install -r test-requirements.txt
186190
# Run all tests
187191
pytest
188192

189-
# Optionally specific tests modules can be runned sepeartely
193+
# Optionally specific tests modules can be runned separately
190194
pytest tests/test_parser.py
191195
```
192196

0 commit comments

Comments
 (0)