From 05cf27af2b79066d74b56a80e06c618e31929ebb Mon Sep 17 00:00:00 2001 From: Daniel Gasienica Date: Tue, 1 May 2018 18:35:19 -0400 Subject: [PATCH 1/2] Document installation on Windows 7 --- CONTRIBUTING.md | 27 +++++++++++++++++---------- 1 file changed, 17 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1c54c7be9..0ec866501 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,24 +29,31 @@ still useful, but it doesn't support `.nvmrc` files. Then you need `git`, if you don't have that yet: https://git-scm.com/ -And for the final step before we actually get started, you'll need build tools to install -the native modules used by the application. On Windows, it's easiest to open the [Command -Prompt (`cmd.exe`) as Administrator]() -and run this: +### macOS -``` -npm install --global --production windows-build-tools -``` +1. Install the [Xcode Command-Line Tools](http://osxdaily.com/2014/02/12/install-command-line-tools-mac-os-x/). + +### Windows + +1. **Windows 7 only:** Install Microsoft .NET Framework 4.5.1: + https://www.microsoft.com/en-us/download/details.aspx?id=40773 +1. Install _Windows Build Tools_: Open the [Command Prompt (`cmd.exe`) as Administrator]() + and run: `npm install --global --production --add-python-to-path windows-build-tools` + +### Linux + +1. Pick your favorite package manager. +1. Install Python 2.x. +1. Install GCC. -On OSX you can install the [XCode Command-line tools](http://osxdaily.com/2014/02/12/install-command-line-tools-mac-os-x/). On Linux you'll need to take a trip to your -favorite package manager. Python 2.x and GCC are two key necessary components. +### All platforms Now, run these commands in your preferred terminal in a good directory for development: ``` git clone https://github.com/signalapp/Signal-Desktop.git cd Signal-Desktop -npm install --global yarn # (only if you don’t already have yarn) +npm install --global yarn # (only if you don’t already have `yarn`) yarn install --frozen-lockfile # Install and build dependencies (this will take a while) yarn grunt # Generate final JS and CSS assets yarn icon-gen # Generate full set of icons for Electron From 40874972de28a64b32d792a0c5e7fc2e7a06fd7a Mon Sep 17 00:00:00 2001 From: Daniel Gasienica Date: Tue, 1 May 2018 18:35:45 -0400 Subject: [PATCH 2/2] Document how to reload app using developer tools --- CONTRIBUTING.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0ec866501..33d931a84 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -61,11 +61,14 @@ yarn test # A good idea to make sure tests run first yarn start # Start Signal! ``` -You'll need to restart the application regularly to see your changes, as there is no -automatic restart mechanism. +You'll need to restart the application regularly to see your changes, as there +is no automatic restart mechanism. Alternatively, keep the developer tools open +(`View > Toggle Developer Tools`), hover over them, and press +Cmd + R (macOS) or Ctrl + R +(Windows & Linux). Also, note that the assets loaded by the application are not necessarily the same files -you're touching. You may not see your changes until you run `yarn grunt` on the +you’re touching. You may not see your changes until you run `yarn grunt` on the command-line like you did during setup. You can make it easier on yourself by generating the latest built assets when you change a file. Run this in its own terminal instance while you make changes: