diff --git a/README.md b/README.md index 1a4ff7d281..1c85faa613 100644 --- a/README.md +++ b/README.md @@ -9,10 +9,12 @@ [![Coverage Status](https://coveralls.io/repos/github/openSUSE/agama/badge.svg?branch=master)](https://coveralls.io/github/openSUSE/agama?branch=master) [![Translation Status](https://l10n.opensuse.org/widgets/agama/-/agama-web/svg-badge.svg)](https://l10n.opensuse.org/engage/agama/) -Agama is a new Linux installer born in the core of the YaST team. It is designed to offer re-usability, integration with third party tools and the possibility of building advanced user interfaces over it. +Agama is a new Linux installer born in the core of the YaST team. It is designed to offer +re-usability, integration with third party tools and the possibility of building advanced user +interfaces over it. -||| -|-|-| +| | | +| -------------------------------------------------------------------- | --------------------------------------------------------------- | | ![Product selection](./doc/images/screenshots/product-selection.png) | ![Installation overview](./doc/images/screenshots/overview.png) |
@@ -20,43 +22,45 @@ Agama is a new Linux installer born in the core of the YaST team. It is designed --- +| | | +| ------------------------------------------------------------ | -------------------------------------------------------------- | +| ![Software page](./doc/images/screenshots/software-page.png) | ![Storage settings](./doc/images/screenshots/storage-page.png) | -||| -|-|-| -| ![Users page](./doc/images/screenshots/users-page.png) | ![Storage settings](./doc/images/screenshots/storage-page.png) | - -||| -|-|-| +| | | +| ------------------------------------------------------ | --------------------------------------------------------------- | | ![Installing](./doc/images/screenshots/installing.png) | ![Installation finished](./doc/images/screenshots/finished.png) | -*Note for developers: For updating the screenshots see the -[integration test documentation](playwright/README.md#updating-the-screenshots).* +_Note for developers: For updating the screenshots see the +[integration test documentation](playwright/README.md#updating-the-screenshots)._
## Why a New Installer -This new project follows two main motivations: to overcome some of the limitations of YaST and to serve as installer for new projects, like those based on SUSE Linux Framework One. +This new project follows two main motivations: to overcome some of the limitations of YaST and to +serve as installer for new projects, like those based on SUSE Linux Framework One. -YaST is a mature installer and control center for SUSE and openSUSE operating systems. With more than 20 years behind it, YaST is a competent and flexible installer able to cover uncountable use cases. But time goes by, and the good old YaST is starting to show its age in some aspects: +YaST is a mature installer and control center for SUSE and openSUSE operating systems. With more +than 20 years behind it, YaST is a competent and flexible installer able to cover uncountable use +cases. But time goes by, and the good old YaST is starting to show its age in some aspects: -* The architecture of YaST is complex and its code-base has too much technical debt. -* Designing and building rich and modern user interfaces is a real challenge. -* Sharing logic with other tools like Salt or Ansible is very difficult. -* Some in-house solutions like [libyui](https://github.com/libyui/libyui) make more difficult to contribute to the project. +- The architecture of YaST is complex and its code-base has too much technical debt. +- Designing and building rich and modern user interfaces is a real challenge. +- Sharing logic with other tools like Salt or Ansible is very difficult. +- Some in-house solutions like [libyui](https://github.com/libyui/libyui) make more difficult to + contribute to the project. ## Running Agama -The easiest way to give Agama a try is to grab a live ISO image and boot it in a virtual -machine. This is also the recommended way if you only want to play and see it in action. If you want -to have a closer look, then clone and configure the project as explained in the next section. +The easiest way to give Agama a try is to grab a live ISO image and boot it in a virtual machine. +This is also the recommended way if you only want to play and see it in action. If you want to have +a closer look, then clone and configure the project as explained in the next section. -You can download the ISO from the [openSUSE Build -Service](https://download.opensuse.org/repositories/systemsmanagement:/Agama:/Devel/images/iso/). +You can download the ISO from the +[openSUSE Build Service](https://download.opensuse.org/repositories/systemsmanagement:/Agama:/Devel/images/iso/). -> [!NOTE] -> Make sure to download the correct ISO file according to your system architecture (eg. you would -> need to choose a file including `x86_64` if you use an Intel or AMD 64-bit processor). +> [!NOTE] Make sure to download the correct ISO file according to your system architecture (eg. you +> would need to choose a file including `x86_64` if you use an Intel or AMD 64-bit processor). ## Remote access @@ -65,24 +69,26 @@ might want to access remotely to the installer. If you know the IP address of th need to point your browser to `https://$IP`. For the case you do not know the address, or just for convenience, the Live ISO is configured to use -mDNS (sometimes called Avahi, Zeroconf, Bonjour) for hostname resolution. Therefore, connecting to `https://agama.local` should do the trick. +mDNS (sometimes called Avahi, Zeroconf, Bonjour) for hostname resolution. Therefore, connecting to +`https://agama.local` should do the trick. ->[!WARNING] -> Do not use the `.local` hostnames in untrusted networks (like public WiFi networks, shared -> networks), it is a security risk. An attacker can easily send malicious responses for the `.local` -> hostname resolutions and point you to a wrong Agama instance which could for example steal your -> root password! +> [!WARNING] Do not use the `.local` hostnames in untrusted networks (like public WiFi networks, +> shared networks), it is a security risk. An attacker can easily send malicious responses for the +> `.local` hostname resolutions and point you to a wrong Agama instance which could for example +> steal your root password! -If you have troubles or you want to know more about this feature, check our [Avahi/mDNS](./doc/avahi.md) documentation. +If you have troubles or you want to know more about this feature, check our +[Avahi/mDNS](./doc/avahi.md) documentation. ## Other Resources -* If you want to know how Agama works, you should read about [Agama's architecture](/doc/architecture.md) -* If you would like to [contribute](#how-to-contribute), you might be interested in: - * [Running Agama from sources](./doc/running.md). - * [Working with Agama's web server](./rust/WEB-SERVER.md). - * [Working with Agama's web UI](./web/README.md). -* You can check the overall status of the project through the [status page](/STATUS.md). +- If you want to know how Agama works, you should read about + [Agama's architecture](/doc/architecture.md) +- If you would like to [contribute](#how-to-contribute), you might be interested in: + - [Running Agama from sources](./doc/running.md). + - [Working with Agama's web server](./rust/WEB-SERVER.md). + - [Working with Agama's web UI](./web/README.md). +- You can check the overall status of the project through the [status page](/STATUS.md). ## How to Contribute diff --git a/doc/images/screenshots/finished.png b/doc/images/screenshots/finished.png index 55c5837e22..5cf71bc9e1 100644 Binary files a/doc/images/screenshots/finished.png and b/doc/images/screenshots/finished.png differ diff --git a/doc/images/screenshots/installing.png b/doc/images/screenshots/installing.png index 029fd3dabb..1e271f4ed8 100644 Binary files a/doc/images/screenshots/installing.png and b/doc/images/screenshots/installing.png differ diff --git a/doc/images/screenshots/overview.png b/doc/images/screenshots/overview.png index a1108cb2b2..d9d3447197 100644 Binary files a/doc/images/screenshots/overview.png and b/doc/images/screenshots/overview.png differ diff --git a/doc/images/screenshots/product-selection.png b/doc/images/screenshots/product-selection.png index b24f72a349..bdd9e1f75b 100644 Binary files a/doc/images/screenshots/product-selection.png and b/doc/images/screenshots/product-selection.png differ diff --git a/doc/images/screenshots/software-page.png b/doc/images/screenshots/software-page.png new file mode 100644 index 0000000000..8dc972812b Binary files /dev/null and b/doc/images/screenshots/software-page.png differ diff --git a/doc/images/screenshots/storage-page.png b/doc/images/screenshots/storage-page.png index 4937eb64a5..fc6a978bac 100644 Binary files a/doc/images/screenshots/storage-page.png and b/doc/images/screenshots/storage-page.png differ diff --git a/doc/images/screenshots/users-page.png b/doc/images/screenshots/users-page.png deleted file mode 100644 index e15a985e08..0000000000 Binary files a/doc/images/screenshots/users-page.png and /dev/null differ