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 flexagon editing in Inkscape
  29
  30 ### Hexaflexagon
  31
  32 Create a new hexaflexagon base file with the following command:
  33
  34 ```
  35 $ ./src/svg_hexaflexagon_editor.py
  36 ```
  37
  38 Open the generated file `inkscape-hexaflexagon-editor.svg` in Inkscape and add
  39 the hexagon content to the layers named *Hexagon 1*, *Hexagon 2*, *Hexagon 3*.
  40
  41 See the hexaflexagon being composed automatically and interactively.
  42
  43 ### Tetraflexagon
  44
  45 Create a new tetraflexagon base file with the following command:
  46
  47 ```
  48 $ ./src/svg_tetraflexagon_editor.py
  49 ```
  50
  51 Open the generated file `inkscape-tetraflexagon-editor.svg` in Inkscape and add
  52 the squares content to the layers named *Square 1*, *Square 2*, *Square 3*.
  53
  54 See the tetraflexagon being composed automatically and interactively.