summaryrefslogtreecommitdiff
path: root/docs/guide/lua
diff options
context:
space:
mode:
Diffstat (limited to 'docs/guide/lua')
-rw-r--r--docs/guide/lua/examples.md4
-rw-r--r--docs/guide/lua/first-widgets.md5
-rw-r--r--docs/guide/lua/installation.md2
-rw-r--r--docs/guide/lua/theming.md2
-rw-r--r--docs/guide/lua/widget.md8
5 files changed, 12 insertions, 9 deletions
diff --git a/docs/guide/lua/examples.md b/docs/guide/lua/examples.md
new file mode 100644
index 0000000..be46b6e
--- /dev/null
+++ b/docs/guide/lua/examples.md
@@ -0,0 +1,4 @@
+# Lua examples
+
+## [Simple Bar](https://github.com/Aylur/astal/tree/main/examples/lua/simple-bar)
+![simple-bar](https://github.com/user-attachments/assets/a306c864-56b7-44c4-8820-81f424f32b9b)
diff --git a/docs/guide/lua/first-widgets.md b/docs/guide/lua/first-widgets.md
index efc1c4f..70cfe0c 100644
--- a/docs/guide/lua/first-widgets.md
+++ b/docs/guide/lua/first-widgets.md
@@ -13,8 +13,7 @@ local App = require("astal.gtk3.app")
App:start({
main = function()
-- you will instantiate Widgets here
- -- or setup anything else if you need
- print("hi")
+ -- and setup anything else if you need
end
})
```
@@ -22,7 +21,7 @@ App:start({
:::
Then run `lua init.lua` in the terminal, and that's it!
-Now you have an instance running with Lua.
+Now you have an Astal instance running written in Lua.
## Root of every shell component: Window
diff --git a/docs/guide/lua/installation.md b/docs/guide/lua/installation.md
index b99d8df..f647ed7 100644
--- a/docs/guide/lua/installation.md
+++ b/docs/guide/lua/installation.md
@@ -9,7 +9,7 @@ Read more about it on the [nix page](../getting-started/nix)
## Arch
```sh
-yay -S lua-libastal-git
+yay -S libastal-lua-git
```
## From Source
diff --git a/docs/guide/lua/theming.md b/docs/guide/lua/theming.md
index 502e8e9..4f556fc 100644
--- a/docs/guide/lua/theming.md
+++ b/docs/guide/lua/theming.md
@@ -39,7 +39,7 @@ App:start({
:::
:::warning
-When using relative paths, so for example `./style.css` keep in mind that they
+When using relative paths, for example `./style.css` keep in mind that they
will be relative to the current working directory.
:::
diff --git a/docs/guide/lua/widget.md b/docs/guide/lua/widget.md
index d9f99fa..593628e 100644
--- a/docs/guide/lua/widget.md
+++ b/docs/guide/lua/widget.md
@@ -139,18 +139,18 @@ These widgets are available by default in Lua.
- Button: [Astal.Button](https://aylur.github.io/libastal/astal3/class.Button.html)
- CenterBox: [Astal.CenterBox](https://aylur.github.io/libastal/astal3/class.CenterBox.html)
- CircularProgress: [Astal.CircularProgress](https://aylur.github.io/libastal/astal3/class.CircularProgress.html)
-- DrawingArea: [Gtk.DrawingArea](https://docs.gtk.org/gtk3/astal3/class.DrawingArea.html)
-- Entry: [Gtk.Entry](https://docs.gtk.org/gtk3/astal3/class.Entry.html)
+- DrawingArea: [Gtk.DrawingArea](https://docs.gtk.org/gtk3/class.DrawingArea.html)
+- Entry: [Gtk.Entry](https://docs.gtk.org/gtk3/class.Entry.html)
- Eventbox: [Astal.EventBox](https://aylur.github.io/libastal/astal3/class.EventBox.html)
- Icon: [Astal.Icon](https://aylur.github.io/libastal/astal3/class.Icon.html)
- Label: [Astal.Label](https://aylur.github.io/libastal/astal3/class.Label.html)
- Levelbar: [Astal.LevelBar](https://aylur.github.io/libastal/astal3/class.LevelBar.html)
- Overlay: [Astal.Overlay](https://aylur.github.io/libastal/astal3/class.Overlay.html)
-- Revealer: [Gtk.Revealer](https://docs.gtk.org/gtk3/astal3/class.Revealer.html)
+- Revealer: [Gtk.Revealer](https://docs.gtk.org/gtk3/class.Revealer.html)
- Scrollable: [Astal.Scrollable](https://aylur.github.io/libastal/astal3/class.Scrollable.html)
- Slider: [Astal.Slider](https://aylur.github.io/libastal/astal3/class.Slider.html)
- Stack: [Astal.Stack](https://aylur.github.io/libastal/astal3/class.Stack.html)
-- Switch: [Gtk.Switch](https://docs.gtk.org/gtk3/astal3/class.Switch.html)
+- Switch: [Gtk.Switch](https://docs.gtk.org/gtk3/class.Switch.html)
- Window: [Astal.Window](https://aylur.github.io/libastal/astal3/class.Window.html)
## Gtk4