Difference between revisions of "Zynthian Software"

Revision as of 16:40, 28 May 2021

1 Official ZynthianOS SD-Images

This is the last official Zynthian SD-Image, based on Raspberry Pi OS:

Last Stable ZynthianOS (MD5-sum)

Note:

This SD-image is pre-configured for official kits v4 & v3. If you are using a different hardware, your first step should be accessing the webconf and configuring your hardware.

1.1 Instructions

For accessing to the webconf tool, see here
Once logged in go to Hardware -> Kit and select "Custom" then click on save button
Then, stil in the Hardware menu, configure each device: Audio, Display, Wiring (use "Dummies" if you do not 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

2 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:

ZynthianOS Nightly Builds

Our nightly build system is based on the fantastic work of @guysoft, the 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!!

3 Preparing the SD-card

Current images are 8 GB 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!

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.

Use 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 this link.

Note:

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.

4 Build your own image

If you like, you can build your own SD image following these instructions:

Building the SD Image using the Setup Script

Also, you would like to try the new docker-builder (thanks @guysoft!!):

Building Zynthian with Docker

@@ Line 1: / Line 1: @@
-== Official Aruk Buster SD-Images (Buster-based) ==
+== Official ZynthianOS SD-Images ==
-The current official Zynthian SD-Image is called '''Aruk Buster'''. It's almost the same than the stretch-based one, but updated and buster-based. Currently we have a first Release Candidate (RC-1):
+This is the last official Zynthian SD-Image, based on Raspberry Pi OS:
-  [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])
+  '''[https://os.zynthian.org/zynthianos-last-stable.zip Last Stable ZynthianOS]''' ([https://os.zynthian.org/zynthianos-last-stable.zip.md5 MD5-sum])
-Latest nightly builds are quite stable, so you sould consider using the last one ...
+{{NoteBox|This SD-image is pre-configured for '''official kits v4 & v3'''. If you are using a different hardware, your first step should be accessing the webconf and configuring your hardware.
-{{NoteBox|Aruk Buster SD-Image is pre-configured for official Kit v3.}}
-== Official Aruk Stretch SD-Images (Stretch-based) ==
+==== Instructions ====
-The former official Zynthian SD-Image is called '''Aruk'''. It's based in Raspbian Stretch and built using a the CustomPiOS system (thanks @guysoft!!):
+* For accessing to the webconf tool, [[Accessing_Zynthian_from_your_computer#Accessing_the_Web_Configuration_Tool|see here]]
+* Once logged in go to Hardware -> Kit and select "Custom" then click on save button
+* Then, stil in the Hardware menu, configure each device: Audio, Display, Wiring (use "Dummies" if you do not 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
+}}
- [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])
+== Nightly Build SD-Images ==
-You shouldn't be using Aruk Stretch without a good reason. We have moved to Buster!!
+If you like to be in the cutting edge, test the latest features and find the bugs, try the nightly builds:
-{{NoteBox|Aruk Stretch SD-Image is pre-configured for official Kit v2.}}
+ '''[https://os.zynthian.org ZynthianOS Nightly Builds]'''
-== Nightly Build SD-Images ==
+Our nightly build system is based on the fantastic work of @guysoft, the [https://github.com/guysoft/CustomPiOS CustomPiOS] system:
-If you really like to be in the cutting edge, try the nightly builds:
+ ''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.''
- [https://os.zynthian.org ZynthianOS nightly builds]
+'''@guysoft has largely contributed to the project by configuring and setting up the ZynthianOS build server. Really big thanks!!'''
 == Preparing the SD-card ==
-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!
+Current images are 8 GB 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!
 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.
@@ Line 41: / Line 44: @@
   [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]