From 121d411855d3a351dbf784065ba5081476bacfdd Mon Sep 17 00:00:00 2001 From: Lucas Date: Sun, 17 Sep 2017 13:44:34 -0700 Subject: [PATCH] Improve readme (#2196) * Improve contribute section of readme file In response to issue #2188, the "Contribute" section of readme.md has been improved. The instructions for Linux, Windows, and macOS have been separated to add clarity to the section in question. * Slight change on top of readme commit Change of grammar on one line. * Removal of npm references from readme update --- readme.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/readme.md b/readme.md index 7457687f..6009bd7b 100644 --- a/readme.md +++ b/readme.md @@ -30,10 +30,22 @@ choco install hyper ## Contribute -1. Install the dependencies - * If you are running Linux, install `icnsutils`, `graphicsmagick`, `xz-utils`, `npm`, `rpm` and `yarn` - * If you are running Windows, install `yarn` (If you use the MSI installer you will need to install npm), and `windows-build-tools` with `yarn global add windows-build-tools`. - * Yarn installation instructions: https://yarnpkg.com/en/docs/install +Regardless of the platform you are working on, you will need to have Yarn installed. If you have never installed Yarn before, you can find out how at: https://yarnpkg.com/en/docs/install. + +1. Install necessary packages: + * Windows + - Be sure to run `yarn global add windows-build-tools` to install `windows-build-tools`. + * macOS + - Once you have installed Yarn, you can skip this section! + * Linux + - RPM-based + + `GraphicsMagick` + + `libicns-utils` + + `xz` (Installed by default on some distributions.) + - Debian-based + + `graphicsmagick` + + `icnsutils` + + `xz-utils` 2. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device 3. Install the dependencies: `yarn` 4. Build the code and watch for changes: `yarn run dev`