Changes

Jump to navigation Jump to search
Line 1: Line 1: −
== Official Aruk Stretch SD-Images (Stretch-based) ==
+
== Official ZynthianOS SD-Images ==
   −
The current official Zynthian SD-Image is called '''Aruk'''. It's based in Raspbian Stretch and built using a the CustomPiOS system (thanks @guysoft!!). Currently we have a third Release Candidate (RC-3):
+
You can download the last official ZynthianOS SD-image, based on Raspberry Pi OS, from here:
   −
  [https://os.zynthian.org/2019-06-26-zynthianos-stretch-lite-1.0.0-RC3.zip ZynthianOS "Aruk Stretch" RC-3] ([https://os.zynthian.org/2019-06-26-zynthianos-stretch-lite-1.0.0-RC3.zip.md5 MD5-sum])
+
  '''[https://os.zynthian.org/zynthianos-last-stable.zip Last Stable ZynthianOS]''' ([https://os.zynthian.org/zynthianos-last-stable.zip.md5 MD5-sum])
 +
<!--
 +
<br>
   −
it will be the last stretch-based Aruk RC because we have moved to Raspbian Buster.
+
The latest staging image is available here:
   −
{{NoteBox|Aruk Stretch SD-Image is pre-configured for official Kit v2.}}
+
'''[https://os.zynthian.org/2023-07-12-zynthianos-staging-2307.zip Last Staging ZynthianOS]''' ([https://os.zynthian.org/2023-07-12-zynthianos-staging-2307.zip.md5 MD5-sum])
 +
<br>
   −
== Testing Aruk Buster SD-Images (Buster-based) ==
+
{{WarningBox|If you have a new V5 kit, you SHOULD download [https://os.zynthian.org/2023-07-12-zynthianos-staging-2307.zip the staging image]. The last stable SD-image has some issues configuring the V5 hardware. We are working to release a new stable image as soon as possible.}}
 +
-->
 +
<br>
   −
The next official Zynthian SD-Image is called '''Aruk Buster'''. It's the same than the stretch-based one, but buster-based. Currently we have a first Release Candidate (RC-1):
+
== Unzipping ==
   −
[https://os.zynthian.org/2019-09-24-zynthianos-buster-lite-1.0.0-RC1.zip ZynthianOS "Aruk Buster" RC-1] ([https://os.zynthian.org/2019-09-24-zynthianos-buster-lite-1.0.0-RC1.zip.md5 MD5-sum])
+
The file you download is a zip file that must be unzipped to get a ''.img'' file that can be 'burnt' to the micro-SD card used by the zynthian device (Raspberry Pi). This process differs depending on the operating system you use: windows, mac or linux.
   −
{{NoteBox|Aruk Buster SD-Image is pre-configured for official Kit v3.}}
+
<!--
 +
== Nightly Build SD-Images ==
 +
 
 +
If you like to be in the cutting edge, test the latest features and find the bugs, try the nightly builds:
 +
 
 +
'''[https://os.zynthian.org ZynthianOS Nightly Builds]'''
 +
 
 +
Our nightly build system is based on the fantastic work of @guysoft, the [https://github.com/guysoft/CustomPiOS CustomPiOS] system:
 +
 
 +
''CustomPiOS is a Raspberry Pi and other ARM devices distribution builder. CustomPiOS opens an already existing image, modifies it and repackages the image ready to ship.''
 +
 
 +
'''@guysoft has largely contributed to the project by configuring and setting up the ZynthianOS build server. Really big thanks!!'''
 +
-->
 +
 
 +
== Preparing the SD-card ==
 +
 
 +
Latest SD-card image weight around 8 GB compressed and around 14 GB unzipped. It includes all the software you need for your zynthian, properly configured for working out-the-box with the latest official kits. Completely ready to use. Plug and play!
 +
 
 +
After downloading and unzipping the SD-image, you have to write it to a suitable SD-card. You need a good-quality SD-card with a '''minimum size of 16GB'''. You can use a bigger one if you like.
   −
== Nightly Build SD-Images ==
+
You can use [https://etcher.io/ Etcher], a free software that works on Mac, Windows and Linux, to write the image into the SD-card. There is a really good manual for this at [https://www.raspberrypi.org/documentation/installation/installing-images/ this link].
 +
 
 +
If you are a terminal guy, ''dd'' or ''pv'' will do the task. Don't forget to ''unmount'' the SD partition before burning and ''sync'' before extracting the card. With root privileges, run something like this:
 +
 
 +
umount /dev/sdc1
 +
pv 2023-08-25-zynthianos-stable-2308.img > /dev/sdc
 +
sync
   −
If you really like to be in the cutting edge, try the nightly builds:
+
or if you are a ''sudoer'':
   −
  [https://os.zynthian.org ZynthianOS nightly builds]
+
  sudo umount /dev/sdc1
 +
sudo pv 2023-08-25-zynthianos-stable-2308.img > /dev/sdc
 +
sudo sync
   −
but if you do so, please, check that the build is green in the Jenkins panel.
     −
== Legacy "Gorgona Omega" SD-Images (Jessie-based) ==
+
{{NoteBox|RBPi2 is not supported by recent zynthian SD-images. If you want to use a RBPi2, you may need to build your own SD-image.}}
   −
{{WarningBox|Gorgona Omega is at the very end of its life cycle and it's not longer maintained. If you use it, probably you will have problems for updating. I strongly suggest using the new ''Aruk SD-image'' (see above).}}
+
<br>
   −
You can download the old Gorgona SD-Images from here:
+
== First Boot ==
   −
* [http://zynthian.org/download/zynthian_gorgona_omega_rbpi3_kitv2-2018-04-03.zip Gorgona Omega, Kit v2]
+
First boot could take some time. Don't be impatient and wait until you see the splash screen with the logo. If you have a recent kit (V3, V4 & V5) and the display remains black after 1 minute, please, re-check the instructions above and re-burn the SD-card again. If this still don't work, try with a different SD-card before reporting in the [https://discourse.zynthian.org forum]. For solving SD-card issues, it could be useful to [https://raspberrytips.com/green-and-red-light-on-raspberry-pi check the RPi4 status LEDs].
   −
* [http://zynthian.org/download/zynthian_gorgona_omega_rbpi3_kitv1-2018-04-03.zip Gorgona Omega, Legacy Kit V1]
+
Once you see the splash screen, it could take some minutes until the system is ready. You deserve a beer, or at less some some tea or coffee. When the first-boot process finishes, the zynthian will reboot and you will be in the main menu, ready to play.
   −
== Preparing the SD-card ==
+
<br>
   −
Current images are 8GB compressed image file compiled for Raspberry Pi 3. These SD card images include all the Zynthian software, properly configured for working with the official kits. Completely ready to use. Plug and play!
+
== Configuration instructions ==
   −
After downloading the SD-image, you have to write it to a SD-card. You need a SD card with a '''minimum size of 16GB''', although you can use a bigger one if you want.
+
Recent SD-images auto-detect latest official kits V3, V4 & V5. If you are using an older kit or a custom hardware, your first step after booting should be accessing the webconf and configuring your hardware.
   −
Use [https://etcher.io/ Etcher] (free software works on Mac, Windows or Linux) to write the image onto the SDcard. Or do it manually! There is a really good manual for this at [https://www.raspberrypi.org/documentation/installation/installing-images/ this link].
+
* For accessing the webconf tool, [[Accessing_Zynthian_from_your_computer#Accessing_the_Web_Configuration_Tool|see here]]
 +
* Once logged-in, go to Hardware -> Kit and select your kit version or "Custom". Click on save button.
 +
* Then, if you have a custom hardware configuration, configure each device: Audio, Display, Wiring. Use "Dummies" if you don't use any encoder/switch. Don't forget to save your configuration after each step.
 +
* When everything is configured, you can reboot Zynthian using the System -> Reboot menu item
   −
{{NoteBox|RBPi2 is not currently supported by the latest official zynthian SD images, so if you want to use a RBPi2, you may need to build your own SD image.}}
+
<br>
   −
== Build your own image ==  
+
== Build your own SD-image ==  
    
If you like, you can build your own SD image following these instructions:
 
If you like, you can build your own SD image following these instructions:
Line 51: Line 84:  
  [https://discourse.zynthian.org/t/new-sd-image-setup-script/283 Building the SD Image using the Setup Script]
 
  [https://discourse.zynthian.org/t/new-sd-image-setup-script/283 Building the SD Image using the Setup Script]
   −
Also, you would like to try the new experimental docker-builder (thanks @guysoft!!):
+
Also, you would like to try the new docker-builder (thanks @guysoft!!):
    
  [https://discourse.zynthian.org/t/building-zynthian-image-now-works-with-docker/2499 Building Zynthian with Docker]
 
  [https://discourse.zynthian.org/t/building-zynthian-image-now-works-with-docker/2499 Building Zynthian with Docker]

Navigation menu