Skip to content

Commit bff936c

Browse files
committed
Improve README files
1 parent 88d420a commit bff936c

File tree

2 files changed

+33
-17
lines changed

2 files changed

+33
-17
lines changed

README.md

Lines changed: 29 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,30 @@ PyWavefront
1212

1313
PyWavefront reads Wavefront 3D object files (`something.obj`, `something.obj.gz`
1414
and `something.mtl`) and generates interleaved vertex data for each material ready for rendering.
15-
Python 3.4+ is supported in PyWavefront 1.0.0+. An older [`python2` branch](https://github.com/pywavefront/PyWavefront/tree/python2) is still provided for Python 2.7.x, however, only fixes and no new features will be backported. A simple (optional) visualization module is also
16-
provided for rendering the object(s). The interleaved data can also be used by
15+
16+
* Python 3.4+ is supported in 1.x versions
17+
* Python 2.7 is supported in 0.x versions
18+
19+
A simple (optional) visualization module is also provided for
20+
rendering the object(s). The interleaved data can also be used by
1721
more modern renderers thought VBOs or VAOs.
1822

19-
Currently the most commonly used features in [the defined specification](https://en.wikipedia.org/wiki/Wavefront_.obj_file) has
20-
been implemented. Positions, texture coordinates, normals, vertex color and material parsing.
21-
We currently don't support parameter space vertices, line elements or smoothing groups.
22-
Create an issue or pull request on github if needed features are missing.
23+
Currently the most commonly used features in [the specification](https://en.wikipedia.org/wiki/Wavefront_.obj_file) has
24+
been implemented:
25+
26+
* Positions
27+
* Texture Coordinates
28+
* Normals
29+
* Vertex Color
30+
* Material parsing
31+
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.
2333

2434
The package is on [pypi](https://pypi.org/project/PyWavefront/)
2535
or can be cloned on [github](https://github.com/pywavefront/PyWavefront).
2636

2737
```
28-
pip install PyWavefront
38+
pip install pywavefront
2939
```
3040

3141
## Usage
@@ -184,20 +194,22 @@ PyWavefront Discord server : https://discord.gg/nMNjbn
184194

185195
## Owners & Maintainers
186196

187-
* Einar Forselv (@einarf)
188-
* Kurt Yoder (@greenmoss)
197+
* Einar Forselv ([@einarf](https://github.com/einarf)) - Main Contact
198+
* Kurt Yoder ([@greenmoss](https://github.com/greenmoss/)) - Backup
189199

190200
## Contributors
191201

192-
* ComFreek
193-
* Daniel Coelho
194-
* dav92lee
195-
* Jerek Shoemaker
196-
* Marxlp
202+
In alphabetical order:
203+
204+
* [ComFreek](https://github.com/ComFreek)
205+
* Daniel Coelho [1danielcoelho](https://github.com/1danielcoelho)
206+
* [@dav92lee](https://github.com/dav92lee)
207+
* Jerek Shoemaker ([intrepid94](https://github.com/intrepid94))
208+
* [Marxlp](https://github.com/Marxlp)
197209
* Mathieu Lamarre
198-
* Oliv4945
199-
* Patrik Huber
200-
* Sérgio Agostinho
210+
* [Oliv4945](https://github.com/Oliv4945)
211+
* Patrik Huber ([patrikhuber](https://github.com/patrikhuber))
212+
* Sérgio Agostinho ([SergioRAgostinho](https://github.com/SergioRAgostinho))
201213
* Zohar Jackson
202214

203215
## Project History

examples/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
## Requirements
44

55
```bash
6+
# Install pywavefront in dev mode if you dont have pywavefront installed
7+
python setup.py develop
8+
9+
# Enter the examples directory and install requirements
610
cd examples
711
pip install -r requirements.txt
812

0 commit comments

Comments
 (0)