svg_tetraflexagon_editor.py: fix coding style
[flexagon-toolkit.git] / README.md
1 # flexagon-toolkit
2
3 flexagon-toolkit is a collection of tools to make it easier to build flexagons.
4
5
6 ## Draw a template
7
8 To draw a template for a hexaflexagon execute:
9
10 ```
11 $ ./src/cairo_hexaflexagon_template.py
12 ```
13
14 And check out the generated `hexaflexagon-template.svg' file.
15
16
17 ## Gimp plugin
18
19 To play with the GIMP plugin, install it with the following command:
20
21 ```
22 $ make install_gimp_plugin 
23 ```
24
25 Then launch Gimp and go to `Filters -> Render -> Hexaflexagon`.
26
27
28 ## Live SVG hexaflexagon editing in Inkscape
29
30 Create a new base file with the following command:
31
32 ```
33 $ ./src/svg_hexaflexagon_editor.py
34 ```
35
36 Open the generated file `inkscape-hexaflexagon-editor.svg` in Inkscape and add
37 the hexagon content to the layers named *Hexagon 1*, *Hexagon 2*, *Hexagon3*.
38
39 See the hexaflexagon being composed automatically and interactively.