Merge branch 'abhinavdoc1' of git://github.com/abhinavsagar/p5.js-web-editor into abhinavsagar-abhinavdoc1

This commit is contained in:
Cassie Tarakajian 2019-03-28 14:24:13 -04:00
commit 98ac3bafcc
3 changed files with 29 additions and 14 deletions

View file

@ -29,6 +29,8 @@ These are the steps that happen when you deploy the application.
You'll only need to do this if you're testing the production environment locally.
Note: The installation steps assume you are using a Unix-like shell. If you are using Windows, you will need to use `copy` instead of `cp`.
1. Clone this repository and `cd` into it
2. `$ npm install`
3. Install MongoDB and make sure it is running

View file

@ -4,6 +4,8 @@ Follow these instructions to set up your development environment, which you need
## Manual Installation
Note: The installation steps assume you are using a Unix-like shell. If you are using Windows, you will need to use `copy` instead of `cp`.
1. Install [node.js](http://nodejs.org/), which also automatically installs the [npm](https://www.npmjs.org) package manager.
2. [Fork](https://help.github.com/articles/fork-a-repo) the [p5.js Web Editor repository](https://github.com/processing/p5.js-web-editor) into your own GitHub account.
3. [Clone](https://help.github.com/articles/cloning-a-repository/) your new fork of the repository from GitHub onto your local computer.
@ -31,6 +33,8 @@ Follow these instructions to set up your development environment, which you need
## Docker Installation
Note: The installation steps assume you are using a Unix-like shell. If you are using Windows, you will need to use `copy` instead of `cp`.
Using Docker, you can have a complete, consistent development environment without having to manually install dependencies such as Node, Mongo, etc. It also helps isolate these dependencies and their data from other projects that you may have on the same computer that use different/conflicting versions, etc.
Note that this takes up a significant amount of space on your machine. Make sure you have at least 5GB free.

View file

@ -31,6 +31,15 @@ Then ask git about the latest changes.
### Apply changes from master branch, adds your changes *after*
git rebase upstream/master
### Switches back to master branch
git checkout master
### Helps other contributors fully understand the changes that you made
git commit -m "Fixed documentation typos"
### Verifies what git will be committing
git status
## CONFLICTS
You will probably have some conflicts!
If its just lib/p5.js and lib/p5.min.js, its easy to fix. just build the project again with grunt.
@ -42,6 +51,6 @@ If its just lib/p5.js and lib/p5.min.js, its easy to fix. just build the p
If you have conflicts in other files & you're not sure how to resolve them... ask for help! Lauren, David, Kevin, and Kate are familiar with recent changes and can help you figure out what's new.
## And finally, for great glory
git push origin
git push --set-upstream origin your-branch-name-backup
Here's a good reference on rebasing, in case you're intensely curious about the technical details. https://www.atlassian.com/git/tutorials/merging-vs-rebasing