📓 Update install instructions, document future features

This commit is contained in:
C-3PO 2018-07-09 01:58:10 +02:00
parent edc2b2672f
commit b6eccc2dab
Signed by: c3po
GPG key ID: 62993C4BB4D86F24
2 changed files with 10 additions and 2 deletions

View file

@ -1,10 +1,11 @@
This tool is used for fetching releases from SWTORs patch server CDN and installing them. This tool is used for fetching releases from SWTORs patch server CDN and installing them.
# Installation # Installation
For this tool to work, ```tsc``` and ```tslint``` must be globally available, e.g. by running: For this tool to work, ```tsc```, ```tslint``` and ```xdelta3``` must be globally available, e.g. by running:
```bash ```bash
npm install -g typescript tslint sudo npm install -g typescript tslint
sudo apt-get install xdelta3
``` ```
Transpile the TypeScript files to JavaScript by running: Transpile the TypeScript files to JavaScript by running:

View file

@ -25,6 +25,13 @@ if (!to.match(/^(0|[1-9][0-9]{0,2})$/)) {
failFunction(`to value "${to.substring(0, 300)}" is not a valid integer; it must be in range [0, 999].`); failFunction(`to value "${to.substring(0, 300)}" is not a valid integer; it must be in range [0, 999].`);
} }
//TODO: set directory with existing patch data
//TODO: set target directory where patch should be installed
//TODO: set temp directory where patch files should be stored.
//TODO: set location of xdelta3 executable
//TODO: set from=any so it detects current version automatically
//TODO: set to=manifest/current to install whatever is the current version in manifest/on CDN
(async () => { (async () => {
const patch = await getPatch(product as Product, Number(from), Number(to)); const patch = await getPatch(product as Product, Number(from), Number(to));
//console.log(patch); //console.log(patch);