From ee3e5c336932f1fe80207802b5552df957e61e1d Mon Sep 17 00:00:00 2001 From: tony Date: Wed, 10 Feb 2016 14:36:33 -0800 Subject: [PATCH 1/2] improve documentation, how to run and install, list of examples --- README | 19 +++++++++++++++++++ examples/list_of_examples.txt | 13 +++++++++++++ examples/mkexampleslist.bash | 8 ++++++++ 3 files changed, 40 insertions(+) create mode 100644 examples/list_of_examples.txt create mode 100755 examples/mkexampleslist.bash diff --git a/README b/README index 09da674..0741827 100644 --- a/README +++ b/README @@ -192,12 +192,31 @@ fuselage design and construction. The shapes are different between a wing and a fuselage, but much of the process is analogous. +HOW TO INSTALL AND RUN +====================== + +1. If you don't have Python, install it (python.org) + +2. Install required python libraries: numpy polygon2 svgwrite + ( Example for Debian or Ubuntu, as root or with sudo: + apt-get install python-numpy python-pip python2.7-dev + pip install polygon2 + pip install svgwrite ) + +3. Get madesigner and unpack it someplace + ( Use git or untar or unzip or your favorite pointy clicky programs ) + +4. Get a command prompt, cd to the directory, and run: + python madesigner.py + + FREQUENTLY ASKED QUESTIONS ========================== Here's a quick FAQ (although no one has yet asked me any questions, so I'm just trying to anticipate what people might be thinking.) + Q: Are you a moron? Haven't you hear of profili (or "xxx" cad program)??? Yes, and I've probably heard of the suggested tool too. :-) diff --git a/examples/list_of_examples.txt b/examples/list_of_examples.txt new file mode 100644 index 0000000..d8ed22f --- /dev/null +++ b/examples/list_of_examples.txt @@ -0,0 +1,13 @@ +example01.mad A very simple example +example02.mad Beginning to add typical wing structures. +example03.mad This example begins to add a bit of complexity to show the power of MA designer. +example04.mad Swept wings are no problem. +example05.mad This example demonstrates how easy it is to create a wing that blends from one airfoil at the root to a completely different airfoil at the tip. +example06.mad This example shows how easy it is to create a complex curved wing using a spline curve to define the cord relative to the span of the wing. +example07.mad This example shows how easy it is to create a wing with a curved sweep. +example08.mad Back to a simpler wing plan, but now lets put the ribs where we want them by entering our own station values. +example09.mad With a simple wing plan and custom station positions, let's start adding more features to our wing. +example10.mad We can skin the wing for sheeting. Sheet position at the time of this example is limited, but this example shows typical "D" construction wing sheeting. +example11.mad Stations! Any feature can start and end at any station. You are the engineer and get to decide what you want, how big, and where it starts and ends. +example12.mad This example adds flaps and ailerons to a tapered wing. +example13.mad This example shows how to build a multi-panel, polyhedral wing. In this case the mh43 glider airfoil is chosen. Notice in the Outer wing tab that the panel is "linked" to the "Inner" wing. diff --git a/examples/mkexampleslist.bash b/examples/mkexampleslist.bash new file mode 100755 index 0000000..cc201f9 --- /dev/null +++ b/examples/mkexampleslist.bash @@ -0,0 +1,8 @@ +#!/bin/bash + +for f in example*mad +do + echo $f $(grep description $f|perl -pe 's{^ *}{};s{<[^<>]+>}{}g'|head -n1) +done \ +> list_of_examples.txt + From 27d050657c98210ac0910d36af809fff6f78c334 Mon Sep 17 00:00:00 2001 From: tony Date: Wed, 10 Feb 2016 16:00:07 -0800 Subject: [PATCH 2/2] openscenegraph is required for viewing result --- README | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README b/README index 0741827..7a28085 100644 --- a/README +++ b/README @@ -197,7 +197,11 @@ HOW TO INSTALL AND RUN 1. If you don't have Python, install it (python.org) -2. Install required python libraries: numpy polygon2 svgwrite +2. If you don't have OpenSceneGraph, install it + ( Example for Debian or Ubuntu, as root or with sudo: + apt-get install openscenegraph ) + +2. Install required python libraries: numpy polygon2 svgwrite openscenegraph ( Example for Debian or Ubuntu, as root or with sudo: apt-get install python-numpy python-pip python2.7-dev pip install polygon2