Skip to content

Commit

Permalink
Updates primarily to the README for Github and PyPI.
Browse files Browse the repository at this point in the history
  • Loading branch information
cwant committed Mar 17, 2018
1 parent aa9e254 commit 610e16b
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 8 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,14 @@ Check out the repository and look in the `demo` directory.
* **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).
* **VTK**: Take a look at `tessagon_vtk_demo.py` for a script that creates all of the current tessagon classes.

This software may also be installed via pip:

`python3 -m pip install tessagon`

or

`pip3 install tessagon`

## How it works

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):
Expand Down
30 changes: 22 additions & 8 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,16 +1,30 @@
from setuptools import setup, find_packages
from codecs import open
from os import path

here = path.abspath(path.dirname(__file__))
long_description = '''
===========================================
tessagon: tessellation / tiling with python
===========================================
# Get the long description from the README file
with open(path.join(here, 'README.md'), encoding='utf-8') as f:
long_description = f.read()
Tessellate your favorite 3D surfaces (technically, 2D manifolds) with
triangles, hexagons, or a number of other curated tiling types!
Please visit the Github repository for documentation:
`<https://github.com/cwant/tessagon>`_
Either checkout the code from the Github project, or install via pip::
python3 -m pip install tessagon
or::
pip3 install tessagon
'''[1:-1]

setup(
name='tessagon',
version='0.4',
version='0.4.2',
description='Tessellate your favorite 2D manifolds with triangles, ' +
'hexagons, and other interesting patterns.',
long_description=long_description,
Expand All @@ -27,7 +41,7 @@
'Topic :: Multimedia :: Graphics :: 3D Modeling',
'Topic :: Scientific/Engineering :: Mathematics',
'Topic :: Scientific/Engineering :: Visualization'],
keywords='tesselation tiling modeling',
keywords='tesselation tiling modeling blender vtk',
packages=find_packages(exclude=['tests', 'demo', 'wire_skin.py']),
python_requires='~=3.5'
)

0 comments on commit 610e16b

Please sign in to comment.