Home
Calamares is the universal installer framework. This wiki is for developers working on Calamares, and for deployers using Calamares as a framework / application for installing a Linux system. There is also generic user documentation that applies to installing-your- system, which might be used by a distro as a basis for their own installer documentation.
- FAQ
- Bug Reports
- Continuous Integration
- IRC - #calamares on Freenode (webchat)
- Send good Bug Reports
- Contribute Translations
- Contribute Code
- Contribute Documentation
The developer's guide contains information on
building Calamares,
on its
design,
and localization.
Much of the technical documentation is in README files in the
source code, though, where it is much closer to the things it
documents. Of particular interest is the /ci/ directory, which is where things-that-are-not-Calamares-itself but related to Calamares development (like the Continuous Integration scripts, like translation tools, and development documentation) end up.
While developing Calamares, it needs testing on virtual or physical machines. The Tester's Guide provides advice on setting up test-systems. It also explains the acceptance tests that should (or might) be done on Calamares.
The deployer's guide describes how to deploy Calamares in your distribuion Live CD or other medium. This is the guide to read when Calamares works and runs properly on your development systems, and you're ready to integrate it with the distribution's install medium.
(In addition there is a list of known issues, common configuration tips and some documentation on specialized topics like LUKS)
The user's guide is intended to be generic instructions for installing with Calamares, describing the various end-user visible parts of the installation process. This is intended as a starting point for distribution documentation, not as a replacement for it.
You can help by translating Calamares into your own language!
There are some general translation guidelines in the translator's guide.