From 32748b6418cb249e576c8c2e8fc7b4967e846e70 Mon Sep 17 00:00:00 2001 From: The Jared Wilcurt Date: Mon, 30 May 2022 12:00:43 -0400 Subject: [PATCH] chore(docs): update contributing section (#569) * Running locally * Update README.md * add table of contents * remove lock file * add lock file to reduce ci time * update ordered list formatting Co-authored-by: The Jared Wilcurt Co-authored-by: Ayushman Chhabra --- README.md | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index a78b5efa8..c32b90906 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,14 @@ Build [NW.js](https://github.com/nwjs/nw.js) applications for Mac, Windows and Linux. +## Table of Contents + +- [Installation](https://github.com/nwutils/nw-builder#installation) +- [Usage](https://github.com/nwutils/nw-builder#usage) +- [API Reference](https://github.com/nwutils/nw-builder#api-reference) +- [Contributing](https://github.com/nwutils/nw-builder#contributing) +- [License](https://github.com/nwutils/nw-builder#license) + ## Installation > Tested and runs on Node 14, 16 and 18! @@ -352,14 +360,22 @@ This project was created by [Steffen Müller](https://github.com/steffenmllr) an ### Getting Started -- Install Node.js (I'd suggest using `nvm`) -- Install your preferred package manager (doesn't have to be `pnpm`, I'm just using it as an example) -- Run `pnpm install` to install dependencies -- Run `pnpm demo` to test your changes at first glance -- Run `pnpm test` to run tests -- Don't forget to run `pnpm format` && `pnpm lint` before commiting your changes +1. Pick and install a Node version manager + * Linux/OSX - [nvm](https://github.com/nvm-sh/nvm) + * Windows 8+ - [nvm-windows](https://github.com/coreybutler/nvm-windows) + * Windows 7 - [nodist](https://github.com/nullivex/nodist) + * Win/Lin/OSX - [volta](https://volta.sh) +1. Use your version manager to install Node 14.19, 16.9, 18.2 or above +1. Run `corepack enable` +1. `corepack prepare pnpm@7.1.7 --activate` +1. `pnpm install` + * If you haven't used `pnpm` before, [here is a cheatsheet](https://dev.to/equiman/npm-vs-yarn-vs-pnpm-commands-cheatsheet-3el8) +1. `pnpm demo` to test your changes at first glance +1. `pnpm test` to run unit tests +1. Don't forget to run `pnpm format && pnpm lint` before commiting your changes ### General Guidelines + - Whenever possible, open an issue before submitting a pull request. - PRs should have short descriptive titles. For example: - fix(docs): fix typo in `options.platform` description @@ -369,4 +385,4 @@ This project was created by [Steffen Müller](https://github.com/steffenmllr) an ## License -MIT +[MIT](https://github.com/nwutils/nw-builder/blob/master/.github/LICENSE)