From 85de24b467d883204aedf97a547c46d5ca40c08b Mon Sep 17 00:00:00 2001 From: Florian Festi Date: Sun, 23 May 2021 15:02:09 +0200 Subject: [PATCH] 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 --- README.rst | 32 ++++++++++++++++++++++++++++++++ documentation/src/README.rst | 1 + documentation/src/static | 1 + 3 files changed, 34 insertions(+) create mode 120000 documentation/src/static diff --git a/README.rst b/README.rst index b0d9b6b..dcc58c9 100644 --- a/README.rst +++ b/README.rst @@ -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 ------------- diff --git a/documentation/src/README.rst b/documentation/src/README.rst index a6210d3..4d547b7 100644 --- a/documentation/src/README.rst +++ b/documentation/src/README.rst @@ -1 +1,2 @@ .. include:: ../../README.rst + :end-before: Documentation diff --git a/documentation/src/static b/documentation/src/static new file mode 120000 index 0000000..382349a --- /dev/null +++ b/documentation/src/static @@ -0,0 +1 @@ +../../static/ \ No newline at end of file