diff --git a/README.md b/README.md index ec23e5ba6..d459d30bd 100644 --- a/README.md +++ b/README.md @@ -161,35 +161,43 @@ node run minMemo noBrowser There are a number of scripts available to help make lauching Superalgos easier and feel more native. To use these scripts, follow the steps for your operating system. -# For **Windows** Users +## For **Windows** Users Open a file browser and navigate to the Superalgos Directory. -Under the folder titled `Launch Scripts` double-click the script `create-shortcut-windows.bat`. +Under the folder titled `Launch-Scripts` double-click the script `create-shortcut-windows.bat`. You will see a shortcut added to your desktop. You can use it to launch Superalgos like any other program on your computer. -**B.** For **Ubuntu** Users +## For **Ubuntu** Users -Open a terminal and run the following command: -`cd Superalgos-develop/Launch-Scripts` -`bash create-shortcut-ubuntu.sh` +Open a terminal and run the following commands: +``` +cd Superalgos/Launch-Scripts +``` +``` +bash create-shortcut-ubuntu.sh +``` After running these commands there will be two shortcuts added. One to your launcher and one to your desktop. The launcher shortcut will work out of the box. The desktop shortcut, however, requires a few additional steps to set up.The following section will walk you through these steps. **A.** Enable Desktop Shortcut First, desktop icons need to be enabled within the Tweaks app. -Check if Tweaks is installed. -If not go to Ubuntu Software. -Install Tweaks. -Open Tweaks. -Under extensions turn on Desktop Icons +* Check if Tweaks is installed. +* If not go to Ubuntu Software. +* Install Tweaks. +* Open Tweaks. +* Under extensions turn on Desktop Icons + +![enable-ubuntu-shortcut](https://user-images.githubusercontent.com/55707292/117553927-f0780300-b019-11eb-9e36-46b509653283.gif) **TIP:** If you do not see the desktop shortcut appear right away you may need to restart your computer. Finally, you will need to enable the desktop shortcut. -Right click Superalgos.desktop and select Allow Launching. +* Right click Superalgos.desktop and select Allow Launching. + +![allow-launching](https://user-images.githubusercontent.com/55707292/117553933-fcfc5b80-b019-11eb-872c-4fad81b184d2.gif) Now both shortcuts will launch Superalgos like any other program on your computer. @@ -244,6 +252,19 @@ journalctl -u superalgos -f Superalgos writes nothing outside of the ```Superalgos``` folder. To completely uninstall the software, just delete the folder. +If you have installed shortcuts for Superalgos you can remove them as follows: + +## For **Windows** Users + +Right-click desktop shortcut and select delete. + +## For **Ubuntu** Users + +Open a terminal and run the following command: +``` +rm ~/Desktop/Superalgos.desktop && rm ~/.local/share/applications/Superalgos.desktop +``` + # Welcome Tutorial Once the app finishes loading, an interactive tutorial takes you by the hand and walks you all around the system while you learn the basic skills required to use the interface, mine data, backtest strategies, and even run a live trading session. It is highly recommended you follow the tutorial until the end, as it is carefully crafted to make your onboarding as easy as possible. Tutorials are the absolute best way to tackle the learning curve. You should do all tutorials before you start exploring other avenues on your own.