From e943504f608f5cb2d9129d3156be6c8441e65b5d Mon Sep 17 00:00:00 2001
From: NissimHadar <nissim.hadar@gmail.com>
Date: Mon, 26 Nov 2018 15:59:08 -0800
Subject: [PATCH] Updated README.md
---
tools/nitpick/README.md | 36 ++++++++++++++++++++++--------------
1 file changed, 22 insertions(+), 14 deletions(-)
diff --git a/tools/nitpick/README.md b/tools/nitpick/README.md
index ae8821c6be..fe027be227 100644
--- a/tools/nitpick/README.md
+++ b/tools/nitpick/README.md
@@ -12,7 +12,7 @@ Nitpick has 5 functions, separated into 4 tabs:
1. Evaluating the results of running tests
1. Web interface
-## Build
+## Build (for developers)
Nitpick is built as part of the High Fidelity build.
### Creating installers
#### Windows
@@ -27,15 +27,17 @@ Nitpick is built as part of the High Fidelity build.
1. Copy created installer to https://hifi-qa.s3.amazonaws.com/nitpick/Windows/nitpick-installer-v1.1.exe: aws s3 cp nitpick-installer-v1.1.exe s3://hifi-qa/nitpick/Mac/nitpick-installer-v1.1.exe
#### Mac
These steps assume the hifi repository has been cloned to `~/hifi`.
+1. (first time) Install brew
+ In a terminal: `/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)`
1. (First time) install create-dmg:
- `brew install create-dmg`
-1. cd to the `build/tools/nitpick/Release` folder
+ In a terminal: `brew install create-dmg`
+1. In a terminal: cd to the `build/tools/nitpick/Release` folder
1. Copy the quazip dynamic library (note final period):
- `cp ~/hifi/build/ext/Xcode/quazip/project/lib/libquazip5.1.dylib .`
+ In a terminal: `cp ~/hifi/build/ext/Xcode/quazip/project/lib/libquazip5.1.dylib .`
1. Change the loader instruction to find the dynamic library locally
- `install_name_tool -change ~/hifi/build/ext/Xcode/quazip/project/lib/libquazip5.1.dylib libquazip5.1.dylib nitpick`
-1. Delete any existing disk images: `rm *.dmg`
-1. Create installer (note final period): `create-dmg --volname nitpick-installer-v1.1 nitpick-installer-v1.1.dmg .`
+ In a terminal: `install_name_tool -change ~/hifi/build/ext/Xcode/quazip/project/lib/libquazip5.1.dylib libquazip5.1.dylib nitpick`
+1. Delete any existing disk images. In a terminal: `rm *.dmg`
+1. Create installer (note final period).In a terminal: `create-dmg --volname nitpick-installer-v1.1 nitpick-installer-v1.1.dmg .`
Make sure to wait for completion.
1. Copy created installer to AWS: `~/Library/Python/3.7/bin/aws s3 cp nitpick-installer-v1.1.dmg s3://hifi-qa/nitpick/Mac/nitpick-installer-v1.1.dmg`
### Installation
@@ -56,16 +58,20 @@ These steps assume the hifi repository has been cloned to `~/hifi`.
1. __To run nitpick, double click **nitpick.exe**__
#### Mac
+1. (first time) Install brew
+ In a terminal: `/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)`
+1. (First time) install Qt:
+ In a terminal: `brew install qt`
1. (First time) install Python from https://www.python.org/downloads/release/python-370/ (**macOS 64-bit installer** or **macOS 64-bit/32-bit installer**)
- 1. After installation - run `open "/Applications/Python 3.6/Install Certificates.command"`. This is needed because the Mac Python supplied no longer links with the deprecated Apple-supplied system OpenSSL libraries but rather supplies a private copy of OpenSSL 1.0.2 which does not automatically access the system default root certificates.
+ 1. After installation - In a terminal: run `open "/Applications/Python 3.6/Install Certificates.command"`. This is needed because the Mac Python supplied no longer links with the deprecated Apple-supplied system OpenSSL libraries but rather supplies a private copy of OpenSSL 1.0.2 which does not automatically access the system default root certificates.
1. Verify that `/usr/local/bin/python3` exists.
1. (First time - AWS interface) Install pip with the script provided by the Python Packaging Authority:
-$ curl -O https://bootstrap.pypa.io/get-pip.py
-$ python3 get-pip.py --user
+In a terminal: `curl -O https://bootstrap.pypa.io/get-pip.py`
+In a terminal: `python3 get-pip.py --user`
1. Use pip to install the AWS CLI.
- $ pip3 install awscli --upgrade --user
+ `pip3 install awscli --upgrade --user`
This will install aws in your user. For user XXX, aws will be located in ~/Library/Python/3.7/bin
- 1. Open a new command prompt and run `aws configure`
+ 1. Open a new command prompt and run `~/Library/Python/3.7/bin/aws configure`
1. Enter the AWS account number
1. Enter the secret key
1. Leave region name and ouput format as default [None]
@@ -75,9 +81,11 @@ $ python3 get-pip.py --user
1. Create a folder for the nitpick files (e.g. ~/nitpick)
If this folder exists then delete all it's contents.
1. Copy the downloaded files to the folder
- `cp -r /Volumes/nitpick-installer-v1.1/* .`
+ In a terminal:
+ `cd ~/nitpick`
+ `cp -r /Volumes/nitpick-installer-v1.1/* .`
-1. __To run nitpick, cd to the folder that you copied to and run `./nitpick`__
+1. __To run nitpick, cd to the folder that you copied to and run `./nitpick`__
#Use
## Create
