1
0
Fork 0

chore(markdown): Linting of dev docs

This commit is contained in:
Joost De Cock 2022-02-19 08:04:25 +01:00
parent 1d8beedd44
commit 265ad404da
317 changed files with 1281 additions and 1503 deletions

View file

@ -3,40 +3,38 @@ title: Understanding Bézier curves
order: 50
---
While lines on computers are easy to store with a start and end point,
While lines on computers are easy to store with a start and end point,
curves require more information.
In FreeSewing — as in SVG and countless of other computer applications —
curves are stored as [Bézier curves](https://en.wikipedia.org/wiki/B%C3%A9zier_curve),
named after French engineer [Pierre Bézier](https://en.wikipedia.org/wiki/Pierre_B%C3%A9zier) who
curves are stored as [Bézier curves](https://en.wikipedia.org/wiki/B%C3%A9zier_curve),
named after French engineer [Pierre Bézier](https://en.wikipedia.org/wiki/Pierre_B%C3%A9zier) who
popularized their use back in the 1960s.
In FreeSewing, we use so-called cubic Bézier curves which have:
- A start point
- A first control point thats linked to the start point
- A second control point thats linked to the end point
- An end point
- A start point
- A first control point thats linked to the start point
- A second control point thats linked to the end point
- An end point
<Example settings_complete="0" part="path_curve">
An example of a Bézier curve drawn by the Path.curve() method
</Example>
Bézier curves and their *handles* or *control points* are surprisingly intuitive.
Bézier curves and their *handles* or *control points* are surprisingly intuitive.
The following illustration does a great job at explaining how they are constructed:
![How Bézier curves are constructed](bezier.gif)
You don't need understand the mathematics behind Bézier Curves.
You don't need understand the mathematics behind Bézier Curves.
As long as you intuitively *get* how the control points influence the curve, you're good to go.
<Note>
###### More on Bézier curves
Wikipedia has a good [introduction to Bézier curves](https://en.wikipedia.org/wiki/B%C3%A9zier_curve).
For a deep-dive into the subject, check out [A Primer on Bézier Curves](https://pomax.github.io/bezierinfo/) by
Wikipedia has a good [introduction to Bézier curves](https://en.wikipedia.org/wiki/B%C3%A9zier_curve).\
For a deep-dive into the subject, check out [A Primer on Bézier Curves](https://pomax.github.io/bezierinfo/) by
[Pomax](https://github.com/Pomax).
</Note>

View file

@ -24,4 +24,3 @@ This is a common point of confusion so keep in mind that the Y-axis may
not behave as you would have intuitively expected.
</Note>

View file

@ -16,7 +16,7 @@ goals:
---
Drawing lines and curves on paper is a skill most people have been practicing since kindergarten.
In FreeSewing, we draw lines and curves with code, which is a bit more abstract
In FreeSewing, we draw lines and curves with code, which is a bit more abstract
but doesn't have to be complicated once you understand a few basic building blocks.
Understanding the concepts that are involved in designing sewing patterns in code will pay dividents later.
@ -30,12 +30,11 @@ That is why we recommend you familiarize yourself with the following topics:
FreeSewing sits at the intersection of the world of makers and developers.
If your background is in development, you will need no explaining what SVG is, but might not
know much about designing sewing patterns.
know much about designing sewing patterns.
If on the other hand your background is in sewing or pattern design, you might wonder what
the heck Node JS is and why you should care.
Few people straddle both worlds, so as you start using FreeSewing, chances are
you'll learn a few new things along the way.
Few people straddle both worlds, so as you start using FreeSewing, chances are
you'll learn a few new things along the way.
</Note>

View file

@ -6,10 +6,9 @@ order: 20
Patterns are rendered as **SVG** — short
for [Scalable Vector Graphics](https://en.wikipedia.org/wiki/Scalable_Vector_Graphics) —
an XML-based vector image format and an open standard.
While you dont need to be an SVG expert, a basic understanding of the format
While you dont need to be an SVG expert, a basic understanding of the format
will greatly help you to understand FreeSewing.
For example, the coordinate system and the way paths
are structured are all related to the SVG drawing system, which is closely related
to other 2D drawing technologies such as PostScript or PDF.

View file

@ -3,14 +3,12 @@ title: Units in FreeSewing
order: 40
---
FreeSewing uses millimeter for all its internal units.
FreeSewing uses millimeter for all its internal units.
We do support both imperial and metrics units, which are displayed
as cm or inch, but under the hood everything is handled in millimeter.
So as a pattern designer, you will work with mm.
When you write `1`, thats one mm. When you write `7.8`, thats 7.8mm.
While you can use cm or inch on the FreeSewing website, that is merely a layer of
While you can use cm or inch on the FreeSewing website, that is merely a layer of
abstration on top of the internal units, which are always mm.