From b82baf1711fe848cce016acccd8f469e233d3d1e Mon Sep 17 00:00:00 2001 From: parteekcoder Date: Fri, 24 Feb 2023 01:30:12 +0530 Subject: [PATCH 1/3] update readme --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 2a285231fe..d59e4acc64 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,26 @@ Learn more about [our community](https://p5js.org/community/) and read our commu Make your first sketch in the [p5.js Editor](https://editor.p5js.org/)! Learn more about sketching with p5.js on the [Get Started](https://p5js.org/get-started/) and find everything you can do in the [Reference](https://p5js.org/reference/). You can also look at [examples](https://editor.p5js.org/p5/sketches) and remix them in the p5.js Editor. +## Setting Development Environment + +- Clone the repo or download zip file +``` +git clone https://github.com/processing/p5.js-web-editor.git +cd p5.js-web-editor +``` +- Intsall dependicies and running server +``` +npm install +npm run start +``` +`Note`:- Use node version 16.14.2 and npm version 8.5.0 run the project + +- Testing using jest +``` +npm run test +``` + + ## Issues If you have found a bug in the p5.js Web Editor, you can file it under the ["issues" tab](https://github.com/processing/p5.js-web-editor/issues). You can also request new features here. A set of templates for reporting issues and requesting features are provided to assist you (and us!). The p5.js Editor is maintained mostly by volunteers, so we thank you for your patience as we try to address your issues as soon as we can. Please post bugs and feature requests in the correct repository if you can: From 822edb32eaec6206e79e2e6fb8073544dc5d95c8 Mon Sep 17 00:00:00 2001 From: parteekcoder Date: Fri, 24 Feb 2023 17:19:45 +0530 Subject: [PATCH 2/3] readme update --- README.md | 18 ++---------------- 1 file changed, 2 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index d59e4acc64..6eaa29372d 100644 --- a/README.md +++ b/README.md @@ -18,22 +18,8 @@ Make your first sketch in the [p5.js Editor](https://editor.p5js.org/)! Learn mo ## Setting Development Environment -- Clone the repo or download zip file -``` -git clone https://github.com/processing/p5.js-web-editor.git -cd p5.js-web-editor -``` -- Intsall dependicies and running server -``` -npm install -npm run start -``` -`Note`:- Use node version 16.14.2 and npm version 8.5.0 run the project - -- Testing using jest -``` -npm run test -``` +- Refer here https://github.com/processing/p5.js-web-editor/blob/develop/contributor_docs/installation.md + ## Issues From 46422f721ed35e758e5571d2c0462c845d4223ee Mon Sep 17 00:00:00 2001 From: parteekcoder Date: Tue, 7 Mar 2023 17:24:22 +0530 Subject: [PATCH 3/3] reviewed changes --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6eaa29372d..2fae732bb6 100644 --- a/README.md +++ b/README.md @@ -16,9 +16,9 @@ Learn more about [our community](https://p5js.org/community/) and read our commu Make your first sketch in the [p5.js Editor](https://editor.p5js.org/)! Learn more about sketching with p5.js on the [Get Started](https://p5js.org/get-started/) and find everything you can do in the [Reference](https://p5js.org/reference/). You can also look at [examples](https://editor.p5js.org/p5/sketches) and remix them in the p5.js Editor. -## Setting Development Environment +## Setting Up the Development Environment -- Refer here https://github.com/processing/p5.js-web-editor/blob/develop/contributor_docs/installation.md +- Refer to [this documentation for setting up your environment](https://github.com/processing/p5.js-web-editor/blob/develop/contributor_docs/installation.md)