summaryrefslogtreecommitdiff
path: root/docs/getting-started/introduction.md
diff options
context:
space:
mode:
authorAylur <[email protected]>2024-09-03 20:32:41 +0200
committerAylur <[email protected]>2024-09-03 20:32:41 +0200
commit6f39857dc7bf59d84c89b311690e858ce0a4724e (patch)
tree4ce9a79816a82de4778e068eadcdfb32b991df17 /docs/getting-started/introduction.md
parentb8acc3897f5c48a5fc4ba73921c77cae2e91598c (diff)
docs: migrate to vitepress
vitepress feels a bit more polished and clean
Diffstat (limited to 'docs/getting-started/introduction.md')
-rw-r--r--docs/getting-started/introduction.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/getting-started/introduction.md b/docs/getting-started/introduction.md
new file mode 100644
index 0000000..252484d
--- /dev/null
+++ b/docs/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](/astal/libraries/overview), you don't have to worry about these,
+you just define the layout, style it with CSS and that's it.