Profouzors
/
boxespy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve README.rst

This commit is contained in:
Florian Festi 2019-02-14 19:21:51 +01:00
parent 0a73e929ec
commit b051f4d0f1
2 changed files with 16 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
README.rst
View File

@ -1,34 +1,22 @@
Boxes.py About Boxes.py
======== ==============
Create boxes and more with a laser cutter! * Boxes.py is an online box generator
Boxes.py is python library for generating drawings to be used with a laser * https://www.festi.info/boxes.py/index.html
cutter. It comes with a growing set of ready-to-use, fully parametrized
generators:
* Boxes in various shapes and with various lids * Boxes.py is an Inkscape plug-in
* Boxes using flex cuts with rounded corners and living hinges * Boxes.py is library to write your own
* Type trays with and without outer walls and floors * Boxes.py is free software licensed under GPL v3+
* Shelves * Boxes.py is written in Python and runs with Python 2 and 3
* Book covers with flex spine
* Magazine files
* Timing belt pulleys and gears
* and more
And a few one trick ponies: Boxes.py comes with a growing set of ready-to-use, fully parametrized
generators. See https://florianfesti.github.io/boxes/html/generators.html for the full list.
* A desktop arcade cabinet
* A drill stand
* A castle tower
* A cutlery stand
Have a look into the examples/ directory <https://github.com/florianfesti/boxes/tree/master/examples/>or the online generator <https://www.festi.info/boxes.py/index.html> to see how the results look like.
Features Features
-------- --------
It generates SVG images that can be viewed directly in a web brower but also Boxes.py generates SVG images that can be viewed directly in a web brower but also
postscript and - with pstoedit as external helper - other vector formats postscript and - with pstoedit as external helper - other vector formats
including dxf, plt (aka hpgl) and gcode. including dxf, plt (aka hpgl) and gcode.
@ -51,21 +39,10 @@ Dovetail joints can be used to join pieces in the same plane.
Flex cuts allows bending and stretching the material in one direction. This Flex cuts allows bending and stretching the material in one direction. This
is used for rounded edges and living hinges. is used for rounded edges and living hinges.
Usage
-----
There are multiple ways to use the available generators:
* Try them out at <https://www.festi.info/boxes.py/index.html>
* Use them as Inkscape extensions under *Extensions->Boxes.py*
* Execute the scripts/boxes tool and pass the name of the generator together with the measurements on the command line.
* Run *scripts/boxesserver* which provides an web interface on port 8000.
* Add a *WSGIScriptAlias* to *scripts/boxesserver* in your httpd config.
You can also create your own generators using *boxes/generators/_template.py* or any of the generators in *boxes/generators* as a starting point.
Documentation Documentation
------------- -------------
The module comes with Sphinx based documentation. The rendered version can be Boxes.py comes with Sphinx based documentation for usage, installation
viewed at <https://florianfesti.github.io/boxes/html/index.html>. and development.
The rendered version can be viewed at <https://florianfesti.github.io/boxes/html/index.html>.

3
documentation/src/index.html
View File

@ -9,7 +9,6 @@
<title>Page Redirection</title> <title>Page Redirection</title>
</head> </head>
<body> <body>
<!-- Note: don't tell people to `click` the link, just tell them that it is a link. --> If you are not redirected automatically, follow this <a href='html/index.html'>link</a>.
If you are not redirected automatically, follow the <a href='html/index.html'>link to example</a>
</body> </body>
</html> </html>