Skip to content

Commit 1ab4117

Browse files
committed
more readme
1 parent 67c9c9f commit 1ab4117

1 file changed

Lines changed: 13 additions & 12 deletions

File tree

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# frentos
22

3-
[The meshmaker.](https://youtu.be/JqgqgcE8Zck)
3+
[The mesh maker.](https://youtu.be/JqgqgcE8Zck)
44

55
[![Build Status](https://travis-ci.org/nschloe/frentos.svg?branch=master)](https://travis-ci.org/nschloe/frentos)
66
[![PyPi Version](https://img.shields.io/pypi/v/frentos.svg)](https://pypi.python.org/pypi/frentos)
@@ -10,10 +10,12 @@ This is frentos, a Python frontend to CGAL's 3D mesh generation capabilities.
1010
frentos aims to make it easy to create high-quality 3D volume and surface
1111
meshes.
1212

13+
### Background
14+
1315
CGAL offers two different approaches for mesh generation:
1416

1517
1. Meshes defined implicitly by level sets of functions.
16-
2. Meshes defined by a collection of bounding planes.
18+
2. Meshes defined by a set of bounding planes.
1719

1820
frentos provides a front-end to the first approach, which has the following
1921
advantages and disadvantages:
@@ -24,9 +26,8 @@ advantages and disadvantages:
2426
need to be specified manually (via features edges, see below), which can be
2527
tedious.
2628

27-
Accordingly the bounding-plane approach, realized by
28-
[mshr](https://bitbucket.org/fenics-project/mshr), has the following advantages
29-
and disadvantages:
29+
On the other hand, the bounding-plane approach (realized by
30+
[mshr](https://bitbucket.org/fenics-project/mshr)), has the following properties:
3031

3132
* Smooth, curved domains are approximated by a set of bounding planes,
3233
resulting in more of less visible edges.
@@ -145,7 +146,7 @@ the mesh.
145146

146147
You can of coure translate, rotate, scale, and stretch any domain. Try, for
147148
example,
148-
```
149+
```python
149150
import frentos
150151

151152
s = frentos.Stretch(
@@ -295,17 +296,17 @@ Ubuntu
295296
```
296297
sudo apt install libcgal-dev libeigen3-dev
297298
```
298-
[meshio](https://github.com/nschloe/meshio) can be helpful in processing the
299-
meshes.
299+
[meshio](https://github.com/nschloe/meshio) (`sudo -H pip install meshio`)
300+
can be helpful in processing the meshes.
300301

301302
#### PyPi
302303
[frentos](https://pypi.python.org/pypi/frentos) is available via PyPi, so
303304
with [pip](https://pypi.python.org/pypi/pip) installed (`sudo apt install
304305
python-pip`) you can simply type
305306
```
306-
sudo -H pip install frentos
307+
sudo -H pip install -U frentos
307308
```
308-
to get started.
309+
to install or upgrade frentos.
309310

310311
#### Manual installation
311312

@@ -321,11 +322,11 @@ the bleeding edge version of frentos), there are two possibilities:
321322

322323
To create a new release
323324

324-
1. bump the `__version__` number,
325+
1. bump the `__version__` number (in `setup.py` _and_ `src/frentos.i`)
325326

326327
2. publish to PyPi and GitHub:
327328
```
328-
$ make publish
329+
make publish
329330
```
330331
331332

0 commit comments

Comments
 (0)