VSinerva/freesewing
1
0
Fork 0
Code Activity

chore: Updated README templates

Browse source
This commit is contained in:
joostdecock 2024-02-04 10:52:16 +01:00
parent 02c619d84c
commit add96a0ee2
87 changed files with 2214 additions and 616 deletions
Download patch file Download diff file Expand all files Collapse all files

33
plugins/core-plugins/README.md
View file

@ -1,4 +1,3 @@
![FreeSewing](https://static.freesewing.org/banner.png)
<p align='center'><a
href="https://www.npmjs.com/package/@freesewing/core-plugins"
title="@freesewing/core-plugins on NPM"
@ -22,7 +21,7 @@
</a><a
href="#contributors-"
title="All Contributors"
><img src="https://img.shields.io/badge/all_contributors-119-pink.svg"
><img src="https://img.shields.io/badge/all_contributors-123-pink.svg"
alt="All Contributors"/>
</a></p><p align='center'><a
href="https://twitter.com/freesewing_org"
@ -81,6 +80,15 @@ let pattern = new freesewing.Pattern().with(plugins);
```
# 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? 🤔
@ -94,6 +102,7 @@ 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:
>
> [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/freesewing/freesewing)
@ -118,7 +127,7 @@ functionality of the platform.
If you have NodeJS installed, you can try it right now by running:
```bash
npx create-freesewing-pattern
npx @freesewing/new-design
```
Getting started guides are available for:
@ -129,12 +138,22 @@ Getting started guides are available for:
The [pattern design tutorial](https://freesewing.dev/tutorials/pattern-design/) will
show you how to create your first parametric design.
## Support FreeSewing: Become a patron 🥰
## Getting started ⚡
FreeSewing is an open source project maintained by Joost De Cock and financially supported by the FreeSewing patrons.
To get started with FreeSewing, you can spin up our development environment with:
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).
```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 👩‍💻