Skip to content

Commit 610e16b

Browse files
committed
Updates primarily to the README for Github and PyPI.
1 parent aa9e254 commit 610e16b

File tree

2 files changed

+30
-8
lines changed

2 files changed

+30
-8
lines changed

README.md

+8
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,14 @@ Check out the repository and look in the `demo` directory.
1313
* **Blender**: you'll find a blender file and `tessagon_blender_demo.py` which creates the meshes in the demo. The demo has examples of each tessagon class, and an example that uses tessagon with one of my other projects, [wire_skin](https://github.com/cwant/wire_skin).
1414
* **VTK**: Take a look at `tessagon_vtk_demo.py` for a script that creates all of the current tessagon classes.
1515

16+
This software may also be installed via pip:
17+
18+
`python3 -m pip install tessagon`
19+
20+
or
21+
22+
`pip3 install tessagon`
23+
1624
## How it works
1725

1826
Three things are needed to use tessagon to tessellate the surface of a 2D-manifold (or more accurately, a patch on a 2D-manifold in 3-space):

setup.py

+22-8
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,30 @@
11
from setuptools import setup, find_packages
2-
from codecs import open
3-
from os import path
42

5-
here = path.abspath(path.dirname(__file__))
3+
long_description = '''
4+
===========================================
5+
tessagon: tessellation / tiling with python
6+
===========================================
67
7-
# Get the long description from the README file
8-
with open(path.join(here, 'README.md'), encoding='utf-8') as f:
9-
long_description = f.read()
8+
Tessellate your favorite 3D surfaces (technically, 2D manifolds) with
9+
triangles, hexagons, or a number of other curated tiling types!
10+
11+
Please visit the Github repository for documentation:
12+
13+
`<https://github.com/cwant/tessagon>`_
14+
15+
Either checkout the code from the Github project, or install via pip::
16+
17+
python3 -m pip install tessagon
18+
19+
or::
20+
21+
pip3 install tessagon
22+
23+
'''[1:-1]
1024

1125
setup(
1226
name='tessagon',
13-
version='0.4',
27+
version='0.4.2',
1428
description='Tessellate your favorite 2D manifolds with triangles, ' +
1529
'hexagons, and other interesting patterns.',
1630
long_description=long_description,
@@ -27,7 +41,7 @@
2741
'Topic :: Multimedia :: Graphics :: 3D Modeling',
2842
'Topic :: Scientific/Engineering :: Mathematics',
2943
'Topic :: Scientific/Engineering :: Visualization'],
30-
keywords='tesselation tiling modeling',
44+
keywords='tesselation tiling modeling blender vtk',
3145
packages=find_packages(exclude=['tests', 'demo', 'wire_skin.py']),
3246
python_requires='~=3.5'
3347
)

0 commit comments

Comments
 (0)