diff --git a/README.md b/README.md new file mode 100644 index 0000000..37115f5 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# QORTector-scripts# + +simple scripts for various needs on the raspberry pi 4 for use with Qortal. + +## to start - install default OS of your choice for raspberry pi 4 - these scripts are tested and working with raspbian and ubuntu 64 for the Raspberry Pi 4.## + +1. Setup your base OS - raspbian or ubuntu 64 (other .deb builds should also work.) + +2. Download all scripts to your home folder. + +3. make all scripts executable (chmod +x *.sh) + +4. run 'default-pi4-ubuntu-qortal-setup.sh' (./default*.sh) - this will install the base level packages you need for Qortal, as well as the Qortal Core. + +5. run 'update-qortal-ui.sh' (./update*.sh) - this will clone+build the Qortal UI from source. + +6. use crontab to setup a cron to start the Qortal Core at boot (crontab -e) add line (@reboot ./start-qortal-at-boot.sh) + +7. use 'Start-Qortal-UI-Electron.sh' to start Qortal UI with Electron wrapper (as an independent application) - Run this script whenever you want to start the UI - placing this script on the desktop is a good idea. Click 'run' when you double-click the script with the GUI. + +8. install 'raspi-config' with 'install-raspi-config.sh' (./install*.sh) + +9. ((OPTIONAL)) - if you prefer to start the Qortal UI as a server that can be accessed by other systems on the network, or SSH tunneled to use locally along with the core, you can use 'start-qortal-ui-at-boot.sh' in cron to start the UI server automatically at boot. + +10. update Qortal UI - you can run 'update-qortal-ui.sh' again to re-clone and build the UI from source again for version updates.