From aba4fd6bb86c5c9c0785cf66c502677ffc4b370a Mon Sep 17 00:00:00 2001 From: Julian Molina Date: Fri, 30 Aug 2019 13:18:10 +0200 Subject: [PATCH] Update README.md --- README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1d71f282e..f6fa3ca24 100644 --- a/README.md +++ b/README.md @@ -120,6 +120,12 @@ Download the software package from the [latest software release](https://github. Download historic market data from the [latest data release](https://github.com/Superalgos/DesktopApp/releases/tag/data.poloniex.btc.usdt.2019.08.27) (```Poloniex.BTC.USDT.Historic.Data.zip```) and extract the file inside the ```Superalgos Desktop App``` folder generated by the software package ZIP. +You should end up with the following folder structure: + +![image](https://user-images.githubusercontent.com/13994516/63965100-be6a7b80-ca98-11e9-9398-40b46be9ecf5.png) + +> Make sure the data ended up as the ```Data-Storage``` folder, right inside ```Superalgos Desktop App``` + **2. Continue with [Running the App](#running-the-app)** > NOTE FOR DEVELOPERS: Instead of using the EXE file to run the app, you may want to use ```node server.js``` from within the ```WebServer``` folder to run on your full Node Js installation. @@ -146,7 +152,7 @@ For your convenience and [for the reasons explained](https://superalgos.org/tool Go to the [latest Data release](https://github.com/Superalgos/DesktopApp/releases/tag/data.poloniex.btc.usdt.2019.08.27) and download ```Poloniex.BTC.USDT.Historic.Data.zip```. -The ZIP file includes highly-compressed complete historic BTC/USDT market data at Poloniex. Expect decompression to take from 1 to 2 hours, depending on your system. Once you have the historic data, the app will make sure the data stays up to date. +The ZIP file includes highly-compressed complete historic BTC/USDT market data at Poloniex. Expect decompression to take from 30 to 60 minutes, depending on your system. Once you have the historic data, the app will make sure the data stays up to date. **4. Extract the ZIP file**: @@ -156,6 +162,8 @@ You should end up with the following folder structure: ![image](https://user-images.githubusercontent.com/13994516/63965100-be6a7b80-ca98-11e9-9398-40b46be9ecf5.png) +> Make sure the data ended up as the ```Data-Storage``` folder, right inside ```Superalgos Desktop App``` + ### Running the App **1. Use the EXE File to Run the App** @@ -184,6 +192,24 @@ That's it! You are up and running! > * The average number of trades per day at the exchange determines the volume of data the app needs to retrieve and process. > * The number of trades the exchange returns per each request determines the size of the pipeline the exchanges allow API users to use. +# Upgrading your Existing Installation + +You should expect patches and even new releases to become available on a regular basis. Appropriate notices will be placed on the [Official Superalgos Telegram Announcements Channel](https://t.me/superalgos), which will be forwarded to the several Community groups when this happens. + +If you have a version of the Superalgos Desktop App and wish to upgrade to a new version you should do the following: + +**1.** Stop the app by closing your browser and the Console/Command Line running the programs. + +**2.** Make sure you are not storing any personal files, such as your Workspace backups and so on in your ```Superalgos Desktop App``` folders. Move them to a different location if you are. + +**3.** Delete all folders within the Superalgos Desktop App folder **but the ```Data-Storage``` folder**. You do not need to get rid of the historic market data every time you upgrade your app. Do **not** delete your ```Data-Storage``` folder. + +> Be aware that you will loose the data corresponding to the latest simulations and live trading operations. + +**4.** Download the latest patch or latest release from the location advertised in the Official Announcement Channel (always beware of what random people may post on open groups). Patches and releases will always be made available at the [Releases page](https://github.com/Superalgos/DesktopApp/releases) of this repository. + +**5.** Extract/unpack the contents of the ZIP file directly into the ```Superalgos Desktop App``` folder. That's it. You are up and running with the new version. Simply start the app the same way you always do. + # Overview > **Watch the [Superalgos Platform Quick Getting Started Guide](https://www.youtube.com/watch?v=_apiM49udL0) video for a quick intro. The current version of the app does not require a log in, so you may ignore that bit.**