diff --git a/README.md b/README.md index 9cccbe93..772abc44 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ If you want to work with Paper.js, simply download the latest "stable" version from [http://paperjs.org/download/](http://paperjs.org/download/) - Website: -- Discussion forum: +- Discussion forum: - Mainline source code: -- Twitter: [@paperjs](http://twitter.com/paperjs) +- Twitter: [@paperjs](https://twitter.com/paperjs) - Latest releases: - Pre-built development versions: [`prebuilt/module`](https://github.com/paperjs/paper.js/tree/prebuilt/module) @@ -53,9 +53,9 @@ generally not recommended to install Node.js through OS-supplied package managers, as the its development cycles move fast and these versions are often out-of-date. -On macOS, [Homebrew](http://brew.sh/) is a good option if one version of +On macOS, [Homebrew](https://brew.sh/) is a good option if one version of Node.js that is kept up to date with `brew upgrade` is enough: - + [NVM](https://github.com/creationix/nvm) can be used instead to install and maintain multiple versions of Node.js on the same platform, as often required by @@ -65,7 +65,7 @@ different projects: Homebrew is recommended on macOS also if you intend to install Paper.js with rendering to the Canvas on Node.js, as described in the next paragraph. -For Linux, see to locate 32-bit and 64-bit Node.js +For Linux, see to locate 32-bit and 64-bit Node.js binaries as well as sources, or use NVM, as described in the paragraph above. ### Installing Paper.js for Node.js @@ -83,11 +83,11 @@ different one: SVG importing and exporting through [jsdom](https://github.com/tmpvar/jsdom). In order to install `paper-jsdom-canvas`, you need the [Cairo Graphics -library](http://cairographics.org/) installed in your system: +library](https://cairographics.org/) installed in your system: ##### Installing Cairo and Pango on macOS: -The easiest way to install Cairo is through [Homebrew](http://brew.sh/), by +The easiest way to install Cairo is through [Homebrew](https://brew.sh/), by issuing the command: brew install cairo pango @@ -162,7 +162,7 @@ run: ### Setting Up For Building -As of 2016, Paper.js uses [Gulp.js](http://gulpjs.com/) for building, and has a +As of 2016, Paper.js uses [Gulp.js](https://gulpjs.com/) for building, and has a couple of dependencies as Bower and NPM modules. Read the chapter [Installing Node.js, NPM and Bower](#installing-nodejs-npm-and-bower) if you still need to install these. @@ -250,7 +250,7 @@ Your docs will then be located at `dist/docs`. ### Testing Paper.js was developed and tested from day 1 using proper unit testing through -jQuery's [Qunit](http://docs.jquery.com/Qunit). To run the tests after any +jQuery's [Qunit](https://qunitjs.com/). To run the tests after any change to the library's source, simply open `index.html` inside the `test` folder in your web browser. There should be a green bar at the top, meaning all tests have passed. If the bar is red, some tests have not passed. These will be @@ -280,10 +280,10 @@ And to test both the PhantomJS and Node.js environments together, simply run: The main Paper.js source tree is hosted on GitHub, thus you should create a fork of the repository in which you perform development. See -. +. We prefer that you send a -[pull request on GitHub](http://help.github.com/pull-requests/) +[pull request on GitHub](https://help.github.com/articles/about-pull-requests/) which will then be merged into the official main line repository. You need to sign the Paper.js CLA to be able to contribute (see below). @@ -295,7 +295,7 @@ In addition to contributing code you can also triage issues which may include re **Get the source (for contributing):** If you want to contribute to the project you will have to [make a -fork](http://help.github.com/forking/). Then do this: +fork](https://help.github.com/articles/fork-a-repo/). Then do this: git clone --recursive git@github.com:yourusername/paper.js.git cd paper.js @@ -308,11 +308,11 @@ To then fetch changes from upstream, run #### Creating and Submitting a Patch As mentioned above, we prefer that you send a -[pull request](http://help.github.com/pull-requests/) on GitHub: +[pull request](https://help.github.com/articles/about-pull-requests/) on GitHub: 1. Create a fork of the upstream repository by visiting . If you feel insecure, here's a - great guide: + great guide: 2. Clone of your repository: `git clone https://yourusername@github.com/yourusername/paper.js.git` @@ -330,7 +330,7 @@ As mentioned above, we prefer that you send a repository's site at GitHub (i.e. https://github.com/yourusername/paper.js) and press the "Pull Request" button. Make sure you are creating the pull request to the `develop` branch, not the `master` branch. Here's a good guide - on pull requests: + on pull requests: ##### Use one topic branch per feature: @@ -339,7 +339,7 @@ together into your `develop` branch (or develop everything in your `develop` branch and then cherry-pick-and-merge into the different topic branches). Git provides for an extremely flexible workflow, which in many ways causes more confusion than it helps you when new to collaborative software development. The -guides provided by GitHub at are a really good +guides provided by GitHub at are a really good starting point and reference. If you are fixing an issue, a convenient way to name the branch is to use the issue number as a prefix, like this: `git checkout -tb issue-937-feature-add-text-styling`. @@ -347,7 +347,7 @@ name the branch is to use the issue number as a prefix, like this: `git checkout #### Contributor License Agreement Before we can accept any contributions to Paper.js, you need to sign this -[CLA](http://en.wikipedia.org/wiki/Contributor_License_Agreement): +[CLA](https://en.wikipedia.org/wiki/Contributor_License_Agreement): [Contributor License Agreement](https://spreadsheets.google.com/a/paperjs.org/spreadsheet/embeddedform?formkey=dENxd0JBVDY2REo3THVuRmh4YjdWRlE6MQ)