diff --git a/Launch-Scripts/create-shortcut-ubuntu.sh b/Launch-Scripts/create-shortcut-ubuntu.sh new file mode 100755 index 000000000..ff10a98c4 --- /dev/null +++ b/Launch-Scripts/create-shortcut-ubuntu.sh @@ -0,0 +1,26 @@ +#!/bin/sh +PWD=`pwd` +DIR=${PWD%/*} + +touch Superalgos.desktop + +echo "[Desktop Entry] +Type=Application +Encoding=UTF-8 +Name=Superalgos +Comment=Launch Shortcut for Superalgos +Path=$PWD +Exec=gnome-terminal -e $PWD/launch-linux.sh +Terminal=true +Icon=$DIR/Projects/Superalgos/Icons/superalgos.png +Categories=Application;" > Superalgos.desktop + +chmod +x Superalgos.desktop + +cp Superalgos.desktop ~/Desktop/Superalgos.desktop +cp Superalgos.desktop ~/.local/share/applications/Superalgos.desktop + +rm Superalgos.desktop + +# Keep terminal open for debugging +#$SHELL \ No newline at end of file diff --git a/Launch-Scripts/launch-linux.sh b/Launch-Scripts/launch-linux.sh index 544a02045..cdbe490aa 100755 --- a/Launch-Scripts/launch-linux.sh +++ b/Launch-Scripts/launch-linux.sh @@ -1 +1 @@ -x-terminal-emulator -e "bash -c 'cd .. && node run; $SHELL'" +x-terminal-emulator -e "cd .. && node run && $SHELL" \ No newline at end of file diff --git a/Projects/Superalgos/GIFs/Docs/launch-scripts/allow-launching.gif b/Projects/Superalgos/GIFs/Docs/launch-scripts/allow-launching.gif new file mode 100644 index 000000000..d3285a60a Binary files /dev/null and b/Projects/Superalgos/GIFs/Docs/launch-scripts/allow-launching.gif differ diff --git a/Projects/Superalgos/GIFs/Docs/launch-scripts/enable-ubuntu-shortcut.gif b/Projects/Superalgos/GIFs/Docs/launch-scripts/enable-ubuntu-shortcut.gif new file mode 100644 index 000000000..b16ebdd2e Binary files /dev/null and b/Projects/Superalgos/GIFs/Docs/launch-scripts/enable-ubuntu-shortcut.gif differ diff --git a/Projects/Superalgos/Schemas/Docs-Topics/launch-scripts-001-launch-scripts.json b/Projects/Superalgos/Schemas/Docs-Topics/launch-scripts-001-launch-scripts.json index 367d184e6..017c7dc88 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/launch-scripts-001-launch-scripts.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/launch-scripts-001-launch-scripts.json @@ -29,7 +29,8 @@ }, { "style": "Note", - "text": "All launch related scripts are held in the Lauch Scripts folder in the main Superalgos directory." + "text": "All launch related scripts are held in the Lauch-Scripts folder in the main Superalgos directory.", + "updated": 1620504577923 }, { "style": "Text", @@ -84,8 +85,8 @@ }, { "style": "Text", - "text": "These scripts automatically create and place shortcuts to the lauch scripts. They can be run from the command line or file browser.", - "updated": 1620052750606 + "text": "These scripts automatically create and place shortcuts to the launch scripts. They can be run from the command line or file browser.", + "updated": 1620504518909 }, { "style": "Subtitle", @@ -108,8 +109,79 @@ }, { "style": "Json", - "text": "Script under development", - "updated": 1620053230467 + "text": "create-shortcut-ubuntu.sh", + "updated": 1620504490683 + }, + { + "style": "Text", + "text": "This script places shortcuts within the user's launcher and desktop. Shortcuts are placed in the following locations:", + "updated": 1620504828523 + }, + { + "style": "List", + "text": "~/Desktop/Superalgos.desktop" + }, + { + "style": "List", + "text": "~/.local/share/applications/Superalgos.desktop" + }, + { + "style": "Note", + "text": "After running create-shortcut-ubuntu.sh the launcher shortcut will work out of the box. There are a few additional steps to set up the desktop shortcut. The following section will walk you through these steps.", + "updated": 1620505700097 + }, + { + "style": "Text", + "text": "First, desktop icons need to be enabled within the Tweaks app.", + "updated": 1620505123531 + }, + { + "style": "List", + "text": "Check if Tweaks is installed.", + "updated": 1620505145330 + }, + { + "style": "List", + "text": "If not go to Ubuntu Software.", + "updated": 1620505149642 + }, + { + "style": "List", + "text": "Install Tweaks.", + "updated": 1620505153965 + }, + { + "style": "List", + "text": "Open Tweaks.", + "updated": 1620505158082 + }, + { + "style": "List", + "text": "Under extensions turn on Desktop Icons" + }, + { + "style": "Gif", + "text": " GIFs/Superalgos/Docs/launch-scripts/enable-ubuntu-shortcut.gif" + }, + { + "style": "Success", + "text": "If you do not see the desktop shortcut appear right away you may need to restart your computer.", + "updated": 1620505754854 + }, + { + "style": "Text", + "text": "Finally, you will need to enable the desktop shortcut.", + "updated": 1620505790748 + }, + { + "style": "List", + "text": "Right click Superalgos.desktop and select Allow Launching.", + "updated": 1620505813768 + }, + { + "style": "Gif", + "text": "GIFs/Superalgos/Docs/launch-scripts/allow-launching.gif", + "updated": 1620505894840 }, { "style": "Subtitle", @@ -128,6 +200,23 @@ "style": "Important", "text": "No scripts started yet. Manual deletion required.", "updated": 1620053525531 + }, + { + "style": "Title", + "text": "Manually Unistall Shortcuts", + "updated": 1620506058024 + }, + { + "style": "Subtitle", + "text": "Ubuntu" + }, + { + "style": "Text", + "text": "Open a terminal and run the following command:" + }, + { + "style": "Javascript", + "text": "rm ~/Desktop/Superalgos.desktop && rm ~/.local/share/applications/Superalgos.desktop" } ] } \ No newline at end of file diff --git a/README.md b/README.md index 5581c4f91..c0e25c436 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ All procedures are the same for Windows, Linux, or Mac OS. Raspberry Pi terminal commands have been included for ease of use. -> **IMPORTANT:** Minimalist hardware —both virtual and physical— is better suited for production deployments, where the use of the GUI is minimal. We highly recommend learning Superalgos in a local installation. Mastering the system takes time, and the use of the GIU to go through in-app tutorials is crucial during the learning process. Your experience will be orders of magnitude better if you follow this advice: leave minimalist hardware for when you are ready to start trading live. +> **IMPORTANT:** Minimalist hardware —both virtual and physical— is better suited for production deployments, where the use of the GUI is minimal. We highly recommend learning Superalgos in a local installation. Mastering the system takes time, and the use of the GUI to go through in-app tutorials is crucial during the learning process. Your experience will be orders of magnitude better if you follow this advice: leave minimalist hardware for when you are ready to start trading live. ![superalgos-readme](https://user-images.githubusercontent.com/13994516/106380124-844d8980-63b0-11eb-9bd9-4f977b6c183b.gif) @@ -144,17 +144,47 @@ node run minMemo noBrowser ## 2. Add a Desktop/Launcher Shortcut for Superalgos -**A.** For **Windows** Users +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 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 -Script under development +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 + +![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. + +![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. ## 3. Usage Notes @@ -207,6 +237,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.