rixty
/
OpenVoiceOS
mirror of https://github.com/OpenVoiceOS/OpenVoiceOS
1
1
Fork 0
Code Issues Releases Wiki Activity

Update README with build instructions (remove the building doc)

This commit is contained in:
j1nx 2021-04-28 09:34:47 +02:00
parent 0043491002
commit 70c8564f9b
2 changed files with 40 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -25,6 +25,46 @@ A minimalistic Linux OS bringing the open source voice assistant Mycroft A.I. to
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.
### Getting the code.
First, get the code on your system! The simplest method is via git.
<br>
- cd ~/
- git clone --recurse-submodules https://github.com/OpenVoiceOS/OpenVoiceOS.git
- cd OpenVoiceOS
### Patching Buildroot.
*(ONLY at the first clean checkout/clone)* If this is the very first time you are going to build an image, you need to execute the following command once;
<br>
- ./scripts/br-patches.sh
<br>
This will patch the Buildroot packages.
## Building the image.
Building the image(s) can be done by utilizing a proper Makefile;
<br>
To see the available commands, just run: 'make help'
<br>
As example to build the rpi3 version;<br>
- make clean
- make rpi4_64-gui-config
- make rpi4_64-gui
Now grab a cup of coffee, go for a walk, sleep and repeat as the build process takes up a long time pulling everything from source and cross compiling everything for the device. Especially the qtwebengine package is taking a LONG time.
<br>
(At the moment there is an outstanding issue which prevents the build to run completely to the end. The plasma-workspace package will error out, not finding the libGLESv4 properly linked within QT5GUI. When the build stopped bacause of this error, edit the following file;
<br>
buildroot/output/host/aarch64-buildroot-linux-gnu/sysroot/usr/lib/cmake/Qt5Gui/Qt5GuiConfigExtras.cmake
<br>
at the bottom of the file replace this line;
<br>
_qt5gui_find_extra_libs(OPENGL "GLES" "" "")
<br>And replace it bit this line;<br>
_qt5gui_find_extra_libs(OPENGL "${CMAKE_SYSROOT}/usr/lib/libGLESv2.so" "" "${CMAKE_SYSROOT}/usr/include/libdrm")
<br>
Then you can continue the build process by re-running the "make rpi4_64-gui" command. (DO NOT, run "make clean" and/or "make rpi4_64-gui-config" again, or you will start from scratch again !!!)
<br>
When everything goes fine the xz compressed image will be available within the release directory.
## Documentation.
More information and instructions can be found within the "documentation" folder.
@ -35,4 +75,3 @@ HelloChatterbox (@hellochatterbox)
### Inspired by;
HassOS (@home-assistant)<br>
Recalbox (Gitlab - @recalbox)

34
documentation/building.md
View File

@ -1,34 +0,0 @@
# Building of MycroftOS from sources.
Flashable images will be provided at major, minor and hotfix release tags. However if you want to build the images from source yourself, below instructions will get you on your way.
## Getting the code.
First, get the code on your system! The simplest method is via git.
<br>
- cd ~/
- git clone --recurse-submodules https://github.com/j1nx/MycroftOS.git
- cd MycroftOS
<br>(Optional) If you want to switch to the active development branch.
- git checkout develop
- git submodule update --remote --merge
## Patching Buildroot.
(ONLY at the first clean checkout/clone) If this is the very first time you are going to build an image, you need to execute the following command once;
<br>
- ./scripts/br-patches.sh
<br>
This will patch the Buildroot packages.
## Building the image.
Building the image(s) can be done by utilizing a proper Makefile;
<br>
To see the available commands, just run: 'make help'
<br>
As example to build the rpi3 version;<br>
- make clean
- make rpi3-config
- make rpi3
To build all available buids, run;<br>
- make all