I add images to README

As README.rst is included from main dir add a symlink so links to the
images work for both locations.

No longer show information about the documentation in the documentation
itself.

Resolves: #292
This commit is contained in:
Florian Festi 2021-05-23 15:02:09 +02:00
parent bdcad5ee27
commit 85de24b467
3 changed files with 34 additions and 0 deletions

View File

@ -1,6 +1,17 @@
About Boxes.py
==============
.. image:: static/samples/NotesHolder.jpg
:width: 18%
.. image:: static/samples/OttoBody.jpg
:width: 18%
.. image:: static/samples/PaintStorage.jpg
:width: 20%
.. image:: static/samples/ShutterBox.jpg
:width: 20%
.. image:: static/samples/TwoPiece.jpg
:width: 19%
* Boxes.py is an online box generator
* https://www.festi.info/boxes.py/index.html
@ -13,6 +24,13 @@ About Boxes.py
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.
.. image:: static/samples/AngledBox.jpg
:width: 33%
.. image:: static/samples/FlexBox2.jpg
:width: 33%
.. image:: static/samples/HingeBox.jpg
:width: 33%
Features
--------
@ -39,6 +57,20 @@ Dovetail joints can be used to join pieces in the same plane.
Flex cuts allows bending and stretching the material in one direction. This
is used for rounded edges and living hinges.
.. image:: static/samples/TypeTray.jpg
:width: 33%
.. image:: static/samples/BinTray.jpg
:width: 33%
.. image:: static/samples/DisplayShelf.jpg
:width: 33%
.. image:: static/samples/AgricolaInsert.jpg
:width: 33%
.. image:: static/samples/HeartBox.jpg
:width: 33%
.. image:: static/samples/Atreus21.jpg
:width: 33%
Documentation
-------------

View File

@ -1 +1,2 @@
.. include:: ../../README.rst
:end-before: Documentation

1
documentation/src/static Symbolic link
View File

@ -0,0 +1 @@
../../static/