Line 3: |
Line 3: |
| ==Introduction== | | ==Introduction== |
| | | |
− | Zynthian '''''Oram''''' is the most recent version of zynthianOS, first released in September 2024. It has some substantial changes compared to earlier versions. This user guide describes the core concepts of the system and gives detailed guidance on how to use it. Note that you can select the documentation for different hardware types (V5, V4, Touch) with the selector in the top right of the page. If you are using V1-V3 then select V4. If you have a custom build, then select the version that closest matches your hardware. If your hardware uses features from different official kits then you may wish to check the documentation for each hardware type. | + | Welcome to the Zynthian project, an open source hardware and software platform for musical explorers. The hardware includes the various official boxes from v1 through to the current (as of July 2025) V5.1 (see history here) and DIY setups (here). On the software side, Zynthian '''Oram''' is the most recent version of zynthianOS, first released in September 2024, it has some substantial changes compared to earlier versions. |
| | | |
− | It is '''strongly recommended that you read section 2 on core concepts''' which explains many aspects of how zynthian works. This provides essential knowledge to improve your understanding and ability to use zynthian. This guide includes details of how to navigate the user interface and some explanation of common workflows. Near the bottom of the guide are links to Learning Pills: short video tutorials that show and describe various workflows. These are short, easily digestible snippets of information that can get you started quickly.
| + | Zynthian is a capable platform that can serve a range of musical needs from practice tool to sound design to live performance rig and more. You find out some of the features on the front page and here (link to features list page) |
| | | |
− | This guide is a living document, subject to frequent updates. Some sections may be incomplete and the whole document will improve during the lifetime of zynthian Oram. If you want to get involved in documentation, visit the [https://discourse.zynthian.org/ forum] and request permission to edit the wiki. | + | === How to get started === |
| + | |
| + | Just to remind those who are new here, there are '''three ways you can get started with Zynthian:''' |
| + | |
| + | # You can purchase an [https://zynthian.org/ official kit] for the most complete experience |
| + | # If you would like to try Zynthian at least cost, you can grab a raspberry pi and a free peripherals and [[No Hardware Build|install a basic setup]] (best with Pi 4b and above) |
| + | # If you're more adventurous you can build yourself an [[Building Zynthian MINI V2|unofficial DIY kit]] or try [https://discourse.zynthian.org/t/success-cases/ DIY your own way] |
| + | |
| + | === Choose your own adventure === |
| + | This user guide describes the core concepts of the system and gives detailed guidance on how to use it. |
| + | <blockquote>'''''You can select the documentation for different hardware types (V5, V4, Touch) with the selector in the top right of the page''''' ↑</blockquote> |
| + | If you are using V1-V3 then select V4. If you have a custom build, then select the version that closest matches your hardware. If your hardware uses features from different official kits then you may wish to check the documentation for each hardware type. |
| + | |
| + | It is '''strongly recommended that you read section 2 on core concepts''' which explains many aspects of how zynthian works. This provides essential knowledge to improve your understanding and ability to use zynthian. This guide includes details of how to navigate the user interface and some explanation of common workflows. |
| + | === Quick Start === |
| + | Near the bottom of the guide are links to '''[[Zynthian UI User Guide - V5#learning pills|Learning Pills]]''': short video tutorials that show and describe various workflows. These are short, easily digestible snippets of information that can get you started quickly. |
| + | |
| + | === The Zynthian Project === |
| + | |
| + | Zynthian is truly a community effort supported by core developers and the wider group of music makers who contribute in various ways whether by questions, testing (making music & experimentation), contributing code or updating this very wiki site. |
| + | |
| + | With that in mind, please know this guide is a living document, subject to frequent updates. Some sections may be incomplete and the whole document will improve during the lifetime of Zynthian Oram. If you want to get involved in documentation, visit the [https://discourse.zynthian.org/ forum] and request permission to edit the wiki. |
| | | |
| ==Basic concepts== | | ==Basic concepts== |