Difference between revisions of "Zynthian Software"

From ZynthianWiki
Jump to navigation Jump to search
(48 intermediate revisions by the same user not shown)
Line 1: Line 1:
The easiest way of getting the software is to download the torrent file for the latest ''official'' SD card image from here:
+
== Official Aruk Buster SD-Images (Buster-based) ==
  
'''[http://zynthian.org/download/zynthian_gorgona_omega_rbpi3_kitv2-2016-04-03.zip.torrent Download Zynthian "Gorgona Omega" SD-image, configured for Kits v2]'''
+
The current official Zynthian SD-Image is called '''Aruk Buster''' and it's based on Raspbian Buster. Currently we have a second Release Candidate (RC-2):
'''[http://zynthian.org/download/zynthian_gorgona_omega_rbpi3_kitv1-2016-04-03.zip.torrent Download Zynthian "Gorgona Omega" SD-image, configured for Kits v1]'''
 
  
It's a 8GB compressed image file (plenty of soundfonts) compiled for Raspberry Pi 3. (Please, keep feeding the torrent after downloading!)
+
'''[https://os.zynthian.org/2020-05-27-zynthianos-buster-lite-1.0.0-RC2.zip ZynthianOS "Aruk Buster" RC-2]''' ([https://os.zynthian.org/2020-05-27-zynthianos-buster-lite-1.0.0-RC2.zip.md5 MD5-sum])
  
These SD card images include all the Zynthian software, properly configured for working with the official kits. Completely ready to use. Plug and play!
+
Nightly builds are available too, so '''[https://os.zynthian.org/ you could consider using the last one]''' and help developers to test the latest features and find the bugs ...
  
After downloading the SD-image, you have to write it to a SDcard. You need a SD card with a minimum size of 16GB, although you can use a bigger one if you want.
+
{{NoteBox|Aruk Buster SD images are pre-configured for official '''Kit v3 Pro'''. If you are using a different hardware, your first step should be accessing the webconf and configuring your hardware.}}
 +
 
 +
== Legacy Aruk Stretch SD-Images (Stretch-based) ==
 +
 
 +
The former official Zynthian SD-Image was called '''Aruk'''. It was based on Raspbian Stretch and the first ZynthianOS SD image built using the [https://github.com/guysoft/CustomPiOS CustomPiOS] system (thanks @guysoft!!):
 +
 
 +
[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])
 +
 
 +
You shouldn't be using Aruk Stretch without a good reason. We have moved to Buster!!
 +
 
 +
{{NoteBox|Aruk Stretch SD-Image is pre-configured for official '''Kit v2'''.}}
 +
 
 +
== Nightly Build SD-Images ==
 +
 
 +
If you like to be in the cutting edge, 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 ==
 +
 
 +
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!
 +
 
 +
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 [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].
 
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].
  
Finally, if you like, you can build your own SD image following these instructions:
+
{{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.}}
 +
 
 +
== Build your own image ==
 +
 
 +
If you like, you can build your own SD image following these instructions:
  
 
  [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 docker-builder (thanks @guysoft!!):
 +
 +
[https://discourse.zynthian.org/t/building-zynthian-image-now-works-with-docker/2499 Building Zynthian with Docker]

Revision as of 16:52, 2 June 2020

1 Official Aruk Buster SD-Images (Buster-based)

The current official Zynthian SD-Image is called Aruk Buster and it's based on Raspbian Buster. Currently we have a second Release Candidate (RC-2):

ZynthianOS "Aruk Buster" RC-2 (MD5-sum)

Nightly builds are available too, so you could consider using the last one and help developers to test the latest features and find the bugs ...

Note:

Aruk Buster SD images are pre-configured for official Kit v3 Pro. If you are using a different hardware, your first step should be accessing the webconf and configuring your hardware.

2 Legacy Aruk Stretch SD-Images (Stretch-based)

The former official Zynthian SD-Image was called Aruk. It was based on Raspbian Stretch and the first ZynthianOS SD image built using the CustomPiOS system (thanks @guysoft!!):

ZynthianOS "Aruk Stretch" RC-3 (MD5-sum)

You shouldn't be using Aruk Stretch without a good reason. We have moved to Buster!!

Note:

Aruk Stretch SD-Image is pre-configured for official Kit v2.

3 Nightly Build SD-Images

If you like to be in the cutting edge, 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!!

4 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!

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.

5 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