1
0
Fork 0
freesewing/plugins/plugin-mirror/README.md

163 lines
6.2 KiB
Markdown
Raw Normal View History

2020-05-10 11:58:02 -05:00
<p align='center'><a
href="https://www.npmjs.com/package/@freesewing/plugin-mirror"
title="@freesewing/plugin-mirror on NPM"
><img src="https://img.shields.io/npm/v/@freesewing/plugin-mirror.svg"
alt="@freesewing/plugin-mirror on NPM"/>
</a><a
href="https://opensource.org/licenses/MIT"
title="License: MIT"
><img src="https://img.shields.io/npm/l/@freesewing/plugin-mirror.svg?label=License"
alt="License: MIT"/>
</a><a
href="https://deepscan.io/dashboard#view=project&tid=2114&pid=2993&bid=23256"
title="Code quality on DeepScan"
><img src="https://deepscan.io/api/teams/2114/projects/2993/branches/23256/badge/grade.svg"
alt="Code quality on DeepScan"/>
</a><a
href="https://github.com/freesewing/freesewing/issues?q=is%3Aissue+is%3Aopen+label%3Apkg%3Aplugin-mirror"
title="Open issues tagged pkg:plugin-mirror"
><img src="https://img.shields.io/github/issues/freesewing/freesewing/pkg:plugin-mirror.svg?label=Issues"
alt="Open issues tagged pkg:plugin-mirror"/>
</a><a
2021-11-28 17:34:00 +01:00
href="#contributors-"
title="All Contributors"
2024-10-26 11:24:47 +02:00
><img src="https://img.shields.io/badge/all_contributors-131-pink.svg"
2021-11-28 17:34:00 +01:00
alt="All Contributors"/>
2020-05-10 11:58:02 -05:00
</a></p><p align='center'><a
href="https://twitter.com/freesewing_org"
title="Follow @freesewing_org on Twitter"
><img src="https://img.shields.io/badge/%F3%A0%80%A0-Follow%20us-blue.svg?logo=twitter&logoColor=white&logoWidth=15"
alt="Follow @freesewing_org on Twitter"/>
</a><a
2020-10-03 16:01:37 +02:00
href="https://chat.freesewing.org"
title="Chat with us on Discord"
><img src="https://img.shields.io/discord/698854858052075530?label=Chat%20on%20Discord"
alt="Chat with us on Discord"/>
2020-05-10 11:58:02 -05:00
</a><a
href="https://freesewing.org/patrons/join"
title="Become a FreeSewing Patron"
><img src="https://img.shields.io/badge/%F3%A0%80%A0-Support%20us-blueviolet.svg?logo=cash-app&logoColor=white&logoWidth=15"
alt="Become a FreeSewing Patron"/>
</a><a
href="https://instagram.com/freesewing_org"
title="Follow @freesewing_org on Twitter"
><img src="https://img.shields.io/badge/%F3%A0%80%A0-Follow%20us-E4405F.svg?logo=instagram&logoColor=white&logoWidth=15"
alt="Follow @freesewing_org on Twitter"/>
</a></p>
2021-02-06 10:25:28 +01:00
# @freesewing/plugin-mirror
2020-05-10 11:58:02 -05:00
A FreeSewing plugin to mirror points or paths
2020-05-10 11:58:02 -05:00
2024-02-04 10:52:16 +01:00
# FreeSewing
> [!TIP]
>#### Support FreeSewing: Become a patron, or make a one-time donation 🥰
>
> FreeSewing is an open source project maintained by Joost De Cock and financially supported by the FreeSewing patrons.
>
> If you feel FreeSewing is worthwhile, and you can spend a few coins without
hardship, then you should [join us and become a patron](https://freesewing.org/community/join).
2022-08-23 13:33:08 +02:00
2021-02-06 10:25:28 +01:00
## What am I looking at? 🤔
2023-09-30 17:40:53 +02:00
This repository is the FreeSewing *monorepo* holding all FreeSewing's websites, documentation, designs, plugins, and other NPM packages.
2021-02-06 10:25:28 +01:00
This folder holds: @freesewing/plugin-mirror
If you're not entirely sure what to do or how to start, type this command:
```
npm run tips
```
2024-02-04 10:52:16 +01:00
> [!NOTE]
2022-06-21 11:11:34 +02:00
> If you don't want to set up a dev environment, you can run it in your browser:
>
> [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/freesewing/freesewing)
>
> We recommend that you fork our repository and then
> put `gitpod.io/#<entire-url-of-your-fork` into a browser
> to start up a browser-based dev environment of your own.
2020-05-10 11:58:02 -05:00
## About FreeSewing 💀
Where the world of makers and developers collide, that's where you'll find FreeSewing.
If you're a maker, checkout [freesewing.org](https://freesewing.org/) where you can generate
2023-09-30 17:40:53 +02:00
sewing patterns adapted to your measurements.
2023-09-30 17:40:53 +02:00
If you're a developer, the FreeSewing documentation lives at [freesewing.dev](https://freesewing.dev/).
The FreeSewing [core library](https://freesewing.dev/reference/api/) is a *batteries-included* toolbox
for parametric design of sewing patterns. But FreeSewing also provides a range
of [plugins](https://freesewing.dev/reference/plugins/) that further extend the
functionality of the platform.
If you have NodeJS installed, you can try it right now by running:
2020-05-10 11:58:02 -05:00
```bash
2024-02-04 10:52:16 +01:00
npx @freesewing/new-design
2020-05-10 11:58:02 -05:00
```
2023-09-30 17:40:53 +02:00
Getting started guides are available for:
- [Linux](https://freesewing.dev/tutorials/getting-started-linux/)
- [MacOS](https://freesewing.dev/tutorials/getting-started-mac/)
- [Windows](https://freesewing.dev/tutorials/getting-started-windows/)
2020-05-10 11:58:02 -05:00
2023-09-30 17:40:53 +02:00
The [pattern design tutorial](https://freesewing.dev/tutorials/pattern-design/) will
show you how to create your first parametric design.
2020-05-10 11:58:02 -05:00
2024-02-04 10:52:16 +01:00
## Getting started ⚡
2020-05-10 11:58:02 -05:00
2024-02-04 10:52:16 +01:00
To get started with FreeSewing, you can spin up our development environment with:
2020-05-10 11:58:02 -05:00
2024-02-04 10:52:16 +01:00
```bash
npx @freesewing/new-design
```
To work with FreeSewing's monorepo, you'll need [NodeJS v18](https://nodejs.org), [lerna](https://lerna.js.org/) and [yarn](https://yarnpkg.com/) on your system.
Once you have those, clone (or fork) this repo and run `yarn kickstart`:
```bash
git clone git@github.com:freesewing/freesewing.git
cd freesewing
yarn kickstart
```
2020-05-10 11:58:02 -05:00
## Links 👩‍💻
2023-09-30 17:40:53 +02:00
**Official channels**
- 💻 Makers website: [FreeSewing.org](https://freesewing.org)
- 💻 Developers website: [FreeSewing.dev](https://freesewing.dev)
- ✅ [Support](https://github.com/freesewing/freesewing/issues/new/choose),
[Issues](https://github.com/freesewing/freesewing/issues) &
[Discussions](https://github.com/freesewing/freesewing/discussions) on
[GitHub](https://github.com/freesewing/freesewing)
**Social media**
- 🐦 Twitter: [@freesewing_org](https://twitter.com/freesewing_org)
- 📷 Instagram: [@freesewing_org](https://instagram.com/freesewing_org)
2020-05-10 11:58:02 -05:00
2023-09-30 17:40:53 +02:00
**Places the FreeSewing community hangs out**
- 💬 [Discord](https://discord.freesewing.org/)
- 💬 [Facebook](https://www.facebook.com/groups/627769821272714/)
- 💬 [Reddit](https://www.reddit.com/r/freesewing/)
2020-05-10 11:58:02 -05:00
## License: MIT 🤓
© [Joost De Cock](https://github.com/joostdecock).
See [the license file](https://github.com/freesewing/freesewing/blob/develop/LICENSE) for details.
## Where to get help 🤯
2023-09-30 17:40:53 +02:00
For [Support](https://github.com/freesewing/freesewing/issues/new/choose),
please use the [Issues](https://github.com/freesewing/freesewing/issues) &
[Discussions](https://github.com/freesewing/freesewing/discussions) on
[GitHub](https://github.com/freesewing/freesewing).
2021-11-27 20:06:56 +01:00