diff --git a/README.md b/README.md index 4279ce783b2..00c45bb552c 100644 --- a/README.md +++ b/README.md @@ -19,9 +19,11 @@ title="Open issues tagged pkg:aaron" >Open issues - All Contributors >Todo list/board

+ + + + + + +

Joost De Cock

🚧
+ + + + + + + + + + + + + +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! \ No newline at end of file diff --git a/config/templates/readme.main.md b/config/templates/readme.main.md new file mode 100644 index 00000000000..d60a0ebea2e --- /dev/null +++ b/config/templates/readme.main.md @@ -0,0 +1,129 @@ +![FreeSewing](https://static.freesewing.org/banner.png) +

@freesewing/core on NPM + License: MIT + DeepScan gradeOpen issues + All Contributors + >Todo list/board +

Follow @freesewing_org on Twitter + Chat with us on Discord + Become a FreeSewing Patron + Follow @freesewing_org on Twitter +

+ +## What am I looking at? 🤔 + +This repository is our *monorepo* holding [all our NPM packages](https://freesewing.dev/reference/packages/). + +## Get involved with FreeSewing v3 🚀 + +Check out [out v3 roadmap](https://github.com/freesewing/freesewing/discussions/1278) to +see what we've planning. And we are open to ideas/suggestions for what you would like to +see in our mext major release. + +## Getting started ⚡ + +As this is a monorepo. You'll need [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 +``` + +## 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 +our sewing patterns adapted to your measurements. + +If you're a developer, our documentation is on [freesewing.dev](https://freesewing.dev/). +Our [core library](https://freesewing.dev/reference/api/) is a *batteries-included* toolbox +for parametric design of sewing patterns. But we also provide 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 create-freesewing-pattern +``` + +Or, consult our getting started guides +for [Linux](https://freesewing.dev/tutorials/getting-started-linux/), +[MacOS](https://freesewing.dev/tutorials/getting-started-mac/), +or [Windows](https://freesewing.dev/tutorials/getting-started-windows/). + +We also have a [pattern design tutorial](https://freesewing.dev/tutorials/pattern-design/) that +walks you through your first parametric design, +and [a friendly community](https://freesewing.org/community/where/) with +people who can help you when you get stuck. + +## Support FreeSewing: Become a patron 🥰 + +FreeSewing is an open source project run by a community, +and financially supported by our patrons. + +If you feel what we do is worthwhile, and you can spend a few coind without +hardship, then you should [join us and become a patron](https://freesewing.org/community/join). + +## Links 👩‍💻 + + - 💻 Makers website: [freesewing.org](https://freesewing.org) + - 💻 Developers website: [freesewing.dev](https://freesewing.dev) + - 💬 Chat: On Discord via [discord.freesewing.org](https://discord.freesewing.org/) + - ✅ Todo list/Kanban board: On Github via [todo.freesewing.org](https://todo.freesewing.org/) + - 🐦 Twitter: [@freesewing_org](https://twitter.com/freesewing_org) + - 📷 Instagram: [@freesewing_org](https://instagram.com/freesewing_org) + +## 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 🤯 + +Our [chatrooms on Discord](https://discord.freesewing.org/) are the best place to ask questions, +share your feedback, or just hang out. + +If you want to report a problem, please [create an issue](https://github.com/freesewing/freesewing/issues/new). + diff --git a/scripts/reconfigure.js b/scripts/reconfigure.js index 378c9e8eb12..8f200cd51bd 100644 --- a/scripts/reconfigure.js +++ b/scripts/reconfigure.js @@ -35,6 +35,8 @@ const packages = glob.sync('*', { }) const contributors = fs.readFileSync(path.join(repoPath, 'CONTRIBUTORS.md'), 'utf-8') +const mainReadme = fs.readFileSync(path.join(repoPath, 'config', 'templates', 'readme.main.md'), 'utf-8') +fs.writeFileSync(path.join(repoPath, 'README.md'), mainReadme + contributors) validate(packages, config) reconfigure(packages, config)