Merge pull request #83 from limitless-code/update-readme

Update readme

README.md

@@ -7,7 +7,7 @@ A minimalistic Linux OS bringing the open source voice assistant Mycroft A.I. to
 - Buildroot 2021.02.x (LTS)
 - Mycroft 20.08.x (mycroft-lib pip installable version)
 - Raspberry Pi 3|3b|3b+ (Initial development hardware = 3b)
-- Raspberry Pi 4 (Current development hardware)
+- Raspberry Pi 4 (Current development hardware, minimum recommended RAM 2GB)
 
 ## Stats:
 
@@ -21,10 +21,43 @@ A minimalistic Linux OS bringing the open source voice assistant Mycroft A.I. to
 | [![Uptime Robot status](https://img.shields.io/website-up-down-green-red/https/shields.io.svg?label=j1nx.nl)](https://stats.uptimerobot.com/Y5L6rSB07) | [![Buy me a](https://img.shields.io/badge/BuyMeABeer-Paypal-blue.svg)](https://www.paypal.me/j1nxnl) |
 | I use uptime robot to monitor for things i can't monitor when the connection drops. | If you feel the need, now it's as easy as clicking this button! |
 
+  
 ## Getting started.
 At this moment development is in very early stages and focussed on the Raspberry Pi 3B & 4. As soon as an initial first workable version
 is created, other hardware might be added.
 
+### Build Environment
+
+Only use x86_64 based architecture/ hardware to build the image. 
+
+The following example Build environment has been tested :
+
+- Architecture: x86_64 
+- Hardware: Intel Core i5 processor, 8GB RAM, 240GB SSD (you can build on less RAM (2GB) and slower storage but more RAM, faster storage =  quicker image building)
+- OS: Ubuntu 20.04 LTS desktop
+
+#### Installing System Build Dependencies
+The following system packages are required to build the image:
+
+- gcc
+- subversion
+- qttools5-dev
+- qttools5-dev-tools
+- python
+- git
+- make
+- g++
+- curl
+- wget
+- qtdeclarative5-dev
+
+#### The following firewall ports need to be allowed to the internet.
+In addition to the usual http/https ports (tcp 80, tcp 443) a couple of other ports need to be allowed to the internet :
+- tcp 9418 (git).
+- tcp 21 (ftp PASV) and random ports for DATA channel. This can be optional but better to have this allowed along with the corresponding random data channel ports. (knowledge of firewalls required)
+
+
+
 ### Getting the code.
 First, get the code on your system! The simplest method is via git.
 <br>
@@ -39,13 +72,6 @@ First, get the code on your system! The simplest method is via git.
 <br>
 This will patch the Buildroot packages.
 
-### Installing System Build Dependencies
-The following system packages are required to build the image:
-- gcc
-- subversion
-- qttools5-dev
-- qttools5-dev-tools
-- python
 
 ## Building the image.
 Building the image(s) can be done by utilizing a proper Makefile;
@@ -73,6 +99,21 @@ Then you can continue the build process by re-running the "make rpi4_64-gui" com
 <br><br>
 When everything goes fine the xz compressed image will be available within the release directory.
 
+
+### Booting image from sd card for the first time (setting up Wifi and backend).
+1.Ensure all required peripherals (mic, speakers, HDMI, usb mouse etc) are plugged in before powering on your RPI4 for the first time.
+<br>
+2. Skip this step if RPI4 is using an ethernet cable. Once powered on, the screen will present the Wifi setup screen ( a Wifi HotSpot is created). Connect to the Wifi HotSpot (ssid OVOS) from another device and follow the on-screen instructions to setup Wifi.
+<br>
+3.Once Wifi is setup a choice of Mycroft backend and Local backend is presented. Choose the Mycroft backend for now and follow the on-screen instructions, Local backend is not ready to use yet. After the pairing process has completed and skills downloaded it's time to test/ use it.
+
+
+### Accessing the CLI.
+
+- SSH to ip address of RPI4 
+- default credentials 'mycroft/mycroft'
+
+
 ## Documentation.
 More information and instructions can be found within the "documentation" folder.
 

buildroot-external/package/mycroft-skill-simple-youtube/mycroft-skill-simple-youtube.mk

@@ -4,7 +4,7 @@
 #
 ################################################################################
 
-MYCROFT_SKILL_SIMPLE_YOUTUBE_VERSION = 5c62b78da07d6912ab0c5a0b57d8ae235473d641
+MYCROFT_SKILL_SIMPLE_YOUTUBE_VERSION = 6427d5c27ebfdbd92048d1812ead827f434c516f
 MYCROFT_SKILL_SIMPLE_YOUTUBE_SITE = git://github.com/JarbasSkills/skill-simple-youtube
 MYCROFT_SKILL_SIMPLE_YOUTUBE_SITE_METHOD = git
 MYCROFT_SKILL_SIMPLE_YOUTUBE_DIRLOCATION = home/mycroft/.local/share/mycroft/skills

buildroot-external/package/python-holmesv/python-holmesv.hash

@@ -1 +1 @@
-sha256  61d81adf9f29329a1bf5b0dcbf874e03f65e2eb2f41b2aab578d3406662c3b59  python-holmesv-119388531b1cd7b8c0d47b8c0083aa895da9faf0.tar.gz
+sha256  a14329f22b7638321af19fb33515d87dc3241bba32ccf331fd3d4e1d4e2b7e38  python-holmesv-11036c18b6eb3425bf0ddab59cac3619195b193c.tar.gz

buildroot-external/package/python-holmesv/python-holmesv.mk

@@ -4,7 +4,7 @@
 #
 ################################################################################
 
-PYTHON_HOLMESV_VERSION = 119388531b1cd7b8c0d47b8c0083aa895da9faf0
+PYTHON_HOLMESV_VERSION = 11036c18b6eb3425bf0ddab59cac3619195b193c
 PYTHON_HOLMESV_SITE = $(call github,HelloChatterbox,HolmesV,$(PYTHON_HOLMESV_VERSION))
 PYTHON_HOLMESV_SETUP_TYPE = setuptools
 PYTHON_HOLMESV_LICENSE_FILES = LICENSE

buildroot-external/package/python-json-database/python-json-database.hash

@@ -1,3 +1,2 @@
-# md5, sha256 from https://pypi.org/pypi/json-database/json
-md5  4d24414c6cf394fbc75ad37297a88351  json_database-0.5.2.tar.gz
-sha256  822ddf0525f5c09de85846d210a6775fba82094d3378fa7352511b5d1f0d1b09  json_database-0.5.2.tar.gz
+# sha256 from https://pypi.org/pypi/json-database/json
+sha256  68745b1265e37e21bd5af8df1f2ef8225ed0c99eddc3aed426b7472ec0669abb  json_database-0.5.6.tar.gz

buildroot-external/package/python-json-database/python-json-database.mk

@@ -4,9 +4,9 @@
 #
 ################################################################################
 
-PYTHON_JSON_DATABASE_VERSION = 0.5.2
+PYTHON_JSON_DATABASE_VERSION = 0.5.6
 PYTHON_JSON_DATABASE_SOURCE = json_database-$(PYTHON_JSON_DATABASE_VERSION).tar.gz
-PYTHON_JSON_DATABASE_SITE = https://files.pythonhosted.org/packages/e1/f0/3a50ed9deed6b55697e30d874605900a5694e8653b9d9747597b1a670dee
+PYTHON_JSON_DATABASE_SITE = https://files.pythonhosted.org/packages/b1/2b/545bb5cafe2cd3876475669c12f31bb1076b609177f16d6efaeb214d038c
 PYTHON_JSON_DATABASE_SETUP_TYPE = setuptools
 
 $(eval $(python-package))

buildroot-external/package/python-ovos-vlc-plugin/python-ovos-vlc-plugin.hash

@@ -1 +1 @@
-sha256  08d3e36f7ffaed1fa2bf5d3fa5728ed7472ec315f6fd022803928a6b5b5c5abf  python-ovos-vlc-plugin-feee64d1cc16f9adf61b593ecb5c65ab4a68cba7.tar.gz
+sha256  ec38eaa022f398c95972982d6f3eb84ce723ef73c768c0da64aec2044602fcfc  python-ovos-vlc-plugin-9ac496337aabd829adcabdef2e2e756bf28aa31b.tar.gz

buildroot-external/package/python-ovos-vlc-plugin/python-ovos-vlc-plugin.mk

@@ -4,7 +4,7 @@
 #
 ################################################################################
 
-PYTHON_OVOS_VLC_PLUGIN_VERSION = feee64d1cc16f9adf61b593ecb5c65ab4a68cba7
+PYTHON_OVOS_VLC_PLUGIN_VERSION = 9ac496337aabd829adcabdef2e2e756bf28aa31b
 PYTHON_OVOS_VLC_PLUGIN_SITE = $(call github,OpenVoiceOS,ovos-vlc-plugin,$(PYTHON_OVOS_VLC_PLUGIN_VERSION))
 PYTHON_OVOS_VLC_PLUGIN_SETUP_TYPE = setuptools
 PYTHON_OVOS_VLC_PLUGIN_LICENSE_FILES = LICENSE