Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-08-06 10:43:45 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Use generic label for version number.

Browse source
This commit is contained in:
NissimHadar 2019-01-09 12:07:18 -08:00
parent da52b9f7b5
commit e9c6d40a91
1 changed files with 10 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
tools/nitpick/README.md
View file

@ -13,7 +13,8 @@ Nitpick has 5 functions, separated into separate tabs:
1. Web interface 1. Web interface
## Build (for developers) ## Build (for developers)
Nitpick is built as part of the High Fidelity build. Nitpick is built as part of the High Fidelity build.
XXXX refers to the version number - replace as necessary. For example, replace with 3.2.11
### Creating installers ### Creating installers
#### Windows #### Windows
1. Perform Release build 1. Perform Release build
@ -23,9 +24,9 @@ Nitpick is built as part of the High Fidelity build.
1. Select all, right-click and select 7-Zip->Add to archive... 1. Select all, right-click and select 7-Zip->Add to archive...
1. Set Archive format to 7z 1. Set Archive format to 7z
1. Check "Create SFX archive 1. Check "Create SFX archive
1. Enter installer name (i.e. `nitpick-installer-v1.3.2.exe`) 1. Enter installer name (i.e. `nitpick-installer-vXXXX.exe`)
1. Click "OK" 1. Click "OK"
1. Copy created installer to https://hifi-qa.s3.amazonaws.com/nitpick/Windows/nitpick-installer-v1.3.2.exe: aws s3 cp nitpick-installer-v1.3.2.exe s3://hifi-qa/nitpick/Mac/nitpick-installer-v1.3.2.exe 1. Copy created installer to https://hifi-qa.s3.amazonaws.com/nitpick/Windows/nitpick-installer-vXXXX.exe: aws s3 cp nitpick-installer-vXXXX.exe s3://hifi-qa/nitpick/Mac/nitpick-installer-vXXXX.exe
#### Mac #### Mac
These steps assume the hifi repository has been cloned to `~/hifi`. These steps assume the hifi repository has been cloned to `~/hifi`.
1. (first time) Install brew 1. (first time) Install brew
@ -39,12 +40,12 @@ These steps assume the hifi repository has been cloned to `~/hifi`.
1. Change the loader instruction to find the dynamic library locally 1. Change the loader instruction to find the dynamic library locally
In a terminal: `install_name_tool -change ~/hifi/build/ext/Xcode/quazip/project/lib/libquazip5.1.dylib libquazip5.1.dylib nitpick` 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. 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.3.2 nitpick-installer-v1.3.2.dmg .` 1. Create installer (note final period).In a terminal: `create-dmg --volname nitpick-installer-vXXXX nitpick-installer-vXXXX.dmg .`
Make sure to wait for completion. Make sure to wait for completion.
1. Copy created installer to AWS: `~/Library/Python/3.7/bin/aws s3 cp nitpick-installer-v1.3.2.dmg s3://hifi-qa/nitpick/Mac/nitpick-installer-v1.3.2.dmg` 1. Copy created installer to AWS: `~/Library/Python/3.7/bin/aws s3 cp nitpick-installer-vXXXX.dmg s3://hifi-qa/nitpick/Mac/nitpick-installer-vXXXX.dmg`
### Installation ### Installation
#### Windows #### Windows
1. (First time) download and install vc_redist.x64.exe (available at https://hifi-qa.s3.amazonaws.com/nitpick/Windows/nitpick-installer-v1.3.2.exe) 1. (First time) download and install vc_redist.x64.exe (available at https://hifi-qa.s3.amazonaws.com/nitpick/Windows/nitpick-installer-vXXXX.exe)
1. (First time) download and install Python 3 from https://hifi-qa.s3.amazonaws.com/nitpick/Windows/python-3.7.0-amd64.exe (also located at https://www.python.org/downloads/) 1. (First time) download and install Python 3 from https://hifi-qa.s3.amazonaws.com/nitpick/Windows/python-3.7.0-amd64.exe (also located at https://www.python.org/downloads/)
1. After installation - create an environment variable called PYTHON_PATH and set it to the folder containing the Python executable. 1. After installation - create an environment variable called PYTHON_PATH and set it to the folder containing the Python executable.
1. (First time) download and install AWS CLI from https://hifi-qa.s3.amazonaws.com/nitpick/Windows/AWSCLI64PY3.msi (also available at https://aws.amazon.com/cli/ 1. (First time) download and install AWS CLI from https://hifi-qa.s3.amazonaws.com/nitpick/Windows/AWSCLI64PY3.msi (also available at https://aws.amazon.com/cli/
@ -54,7 +55,7 @@ These steps assume the hifi repository has been cloned to `~/hifi`.
1. Leave region name and ouput format as default [None] 1. Leave region name and ouput format as default [None]
1. Install the latest release of Boto3 via pip: `pip install boto3` 1. Install the latest release of Boto3 via pip: `pip install boto3`
1. Download the installer by browsing to [here](<https://hifi-qa.s3.amazonaws.com/nitpick/Windows/nitpick-installer-v1.3.2.exe>) 1. Download the installer by browsing to [here](<https://hifi-qa.s3.amazonaws.com/nitpick/Windows/nitpick-installer-vXXXX.exe>)
1. Double click on the installer and install to a convenient location 1. Double click on the installer and install to a convenient location
![](./setup_7z.PNG) ![](./setup_7z.PNG)
@ -78,14 +79,14 @@ In a terminal: `python3 get-pip.py --user`
1. Enter the secret key 1. Enter the secret key
1. Leave region name and ouput format as default [None] 1. Leave region name and ouput format as default [None]
1. Install the latest release of Boto3 via pip: pip3 install boto3 1. Install the latest release of Boto3 via pip: pip3 install boto3
1. Download the installer by browsing to [here](<https://hifi-qa.s3.amazonaws.com/nitpick/Mac/nitpick-installer-v1.3.2.dmg>). 1. Download the installer by browsing to [here](<https://hifi-qa.s3.amazonaws.com/nitpick/Mac/nitpick-installer-vXXXX.dmg>).
1. Double-click on the downloaded image to mount it 1. Double-click on the downloaded image to mount it
1. Create a folder for the nitpick files (e.g. ~/nitpick) 1. Create a folder for the nitpick files (e.g. ~/nitpick)
If this folder exists then delete all it's contents. If this folder exists then delete all it's contents.
1. Copy the downloaded files to the folder 1. Copy the downloaded files to the folder
In a terminal: In a terminal:
`cd ~/nitpick` `cd ~/nitpick`
`cp -r /Volumes/nitpick-installer-v1.3.2/* .` `cp -r /Volumes/nitpick-installer-vXXXX/* .`
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`__
# Usage # Usage