117 lines
4 KiB
Markdown
117 lines
4 KiB
Markdown
{{{badges}}}
|
|
|
|
# {{{fullname}}}
|
|
|
|
{{description}}
|
|
|
|
{{{info}}}
|
|
|
|
# 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).
|
|
|
|
## What am I looking at? 🤔
|
|
|
|
This repository is the FreeSewing *monorepo* holding all FreeSewing's websites, documentation, designs, plugins, and other NPM packages.
|
|
|
|
This folder holds: {{{fullname}}}
|
|
|
|
If you're not entirely sure what to do or how to start, type this command:
|
|
|
|
```
|
|
npm run tips
|
|
```
|
|
|
|
> [!NOTE]
|
|
> If you don't want to set up a dev environment, you can run it in your browser:
|
|
>
|
|
> [](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.
|
|
|
|
## 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
|
|
sewing patterns adapted to your measurements.
|
|
|
|
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:
|
|
|
|
```bash
|
|
npx @freesewing/new-design
|
|
```
|
|
|
|
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/)
|
|
|
|
The [pattern design tutorial](https://freesewing.dev/tutorials/pattern-design/) will
|
|
show you how to create your first parametric design.
|
|
|
|
## Getting started ⚡
|
|
|
|
To get started with FreeSewing, you can spin up our development environment with:
|
|
|
|
```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
|
|
```
|
|
|
|
## Links 👩💻
|
|
|
|
**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)
|
|
|
|
**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/)
|
|
|
|
## 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 🤯
|
|
|
|
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).
|
|
|