From 65654282a98cb0590d498e4ed9c924f97646f1dc Mon Sep 17 00:00:00 2001 From: Aylur Date: Wed, 25 Sep 2024 23:22:01 +0000 Subject: docs: restructure --- docs/guide/getting-started/introduction.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 docs/guide/getting-started/introduction.md (limited to 'docs/guide/getting-started/introduction.md') diff --git a/docs/guide/getting-started/introduction.md b/docs/guide/getting-started/introduction.md new file mode 100644 index 0000000..92d2ff1 --- /dev/null +++ b/docs/guide/getting-started/introduction.md @@ -0,0 +1,23 @@ +# Introduction + +## What is Astal? + +Astal (_meaning "desk"_) is a bundle of libraries built using [GLib](https://docs.gtk.org/glib/) in Vala and C. +The core library [libastal](https://aylur.github.io/libastal) has some Gtk widgets that come packaged, +the most important one is the [Window](https://aylur.github.io/libastal/class.Window.html) which is the main toplevel component using [gtk-layer-shell](https://github.com/wmww/gtk-layer-shell). +This is what allows us to use Gtk as shell components on Wayland. +libastal also comes with some utility functions such as running external processes, +reading, writing and monitoring files. + +## Why Astal? + +What makes Astal convenient to use is not the core library, as it could easily be replaced +by the standard library of any of your favorite language that has bindings to Gtk, it is the +accompanying libraries (_formerly known as "services" in AGS_) + +Have you ever wanted to write a custom bar, custom notification popups +or an applauncher, but gave up because writing a workspace widget, +implementing the notification daemon or handling a search filter was too much of a hassle? + +Astal libraries have you [covered](/guide/libraries/references), you don't have to worry about these, +you just define the layout, style it with CSS and that's it. -- cgit v1.2.3